Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostAccountLinks

Description

Contains the different functions to run the operation postAccountLinks

Synopsis

postAccountLinks :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostAccountLinksRequestBody -> m (Either HttpException (Response PostAccountLinksResponse))
postAccountLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostAccountLinksRequestBody -> m (Either HttpException (Response ByteString))
postAccountLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountLinksResponse))
postAccountLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostAccountLinksRequestBody = PostAccountLinksRequestBody {
}
data PostAccountLinksRequestBodyCollect'
data PostAccountLinksRequestBodyType'
data PostAccountLinksResponse

Documentation

postAccountLinks Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostAccountLinksRequestBody	The request body to send
-> m (Either HttpException (Response PostAccountLinksResponse))	Monad containing the result of the operation

POST /v1/account_links

<p>Creates an AccountLink object that returns a single-use Stripe URL that the user can redirect their user to in order to take them through the Connect Onboarding flow.</p>

postAccountLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostAccountLinksRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/account_links

The same as postAccountLinks but returns the raw ByteString

postAccountLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountLinksResponse)) Source #

POST /v1/account_links

Monadic version of postAccountLinks (use with runWithConfiguration)

postAccountLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostAccountLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/account_links

Monadic version of postAccountLinksRaw (use with runWithConfiguration)

data PostAccountLinksRequestBody Source #

Defines the data type for the schema postAccountLinksRequestBody

Constructors

PostAccountLinksRequestBody

Fields

postAccountLinksRequestBodyAccount :: String
account: The identifier of the account to create an account link for.
Constraints:
- Maximum length of 5000
postAccountLinksRequestBodyCollect :: Maybe PostAccountLinksRequestBodyCollect'
collect: Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.
postAccountLinksRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postAccountLinksRequestBodyFailureUrl :: String
failure_url: The URL that the user will be redirected to if the account link is no longer valid.
postAccountLinksRequestBodySuccessUrl :: String
success_url: The URL that the user will be redirected to upon leaving or completing the linked flow successfully.
postAccountLinksRequestBodyType :: PostAccountLinksRequestBodyType'
type: The type of account link the user is requesting. Possible values are `custom_account_verification` or `custom_account_update`.

Instances

Eq PostAccountLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods (==) :: PostAccountLinksRequestBody -> PostAccountLinksRequestBody -> Bool # (/=) :: PostAccountLinksRequestBody -> PostAccountLinksRequestBody -> Bool #
Show PostAccountLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods showsPrec :: Int -> PostAccountLinksRequestBody -> ShowS # show :: PostAccountLinksRequestBody -> String # showList :: [PostAccountLinksRequestBody] -> ShowS #
ToJSON PostAccountLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods toJSON :: PostAccountLinksRequestBody -> Value # toEncoding :: PostAccountLinksRequestBody -> Encoding # toJSONList :: [PostAccountLinksRequestBody] -> Value # toEncodingList :: [PostAccountLinksRequestBody] -> Encoding #
FromJSON PostAccountLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods parseJSON :: Value -> Parser PostAccountLinksRequestBody # parseJSONList :: Value -> Parser [PostAccountLinksRequestBody] #

data PostAccountLinksRequestBodyCollect' Source #

Defines the enum schema postAccountLinksRequestBodyCollect'

Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.

Constructors

PostAccountLinksRequestBodyCollect'EnumOther Value
PostAccountLinksRequestBodyCollect'EnumTyped String
PostAccountLinksRequestBodyCollect'EnumStringCurrentlyDue
PostAccountLinksRequestBodyCollect'EnumStringEventuallyDue

Instances

Eq PostAccountLinksRequestBodyCollect' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods (==) :: PostAccountLinksRequestBodyCollect' -> PostAccountLinksRequestBodyCollect' -> Bool # (/=) :: PostAccountLinksRequestBodyCollect' -> PostAccountLinksRequestBodyCollect' -> Bool #
Show PostAccountLinksRequestBodyCollect' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods showsPrec :: Int -> PostAccountLinksRequestBodyCollect' -> ShowS # show :: PostAccountLinksRequestBodyCollect' -> String # showList :: [PostAccountLinksRequestBodyCollect'] -> ShowS #
ToJSON PostAccountLinksRequestBodyCollect' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods toJSON :: PostAccountLinksRequestBodyCollect' -> Value # toEncoding :: PostAccountLinksRequestBodyCollect' -> Encoding # toJSONList :: [PostAccountLinksRequestBodyCollect'] -> Value # toEncodingList :: [PostAccountLinksRequestBodyCollect'] -> Encoding #
FromJSON PostAccountLinksRequestBodyCollect' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods parseJSON :: Value -> Parser PostAccountLinksRequestBodyCollect' # parseJSONList :: Value -> Parser [PostAccountLinksRequestBodyCollect'] #

data PostAccountLinksRequestBodyType' Source #

Defines the enum schema postAccountLinksRequestBodyType'

The type of account link the user is requesting. Possible values are `custom_account_verification` or `custom_account_update`.

Constructors

PostAccountLinksRequestBodyType'EnumOther Value
PostAccountLinksRequestBodyType'EnumTyped String
PostAccountLinksRequestBodyType'EnumStringCustomAccountUpdate
PostAccountLinksRequestBodyType'EnumStringCustomAccountVerification

Instances

Eq PostAccountLinksRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods (==) :: PostAccountLinksRequestBodyType' -> PostAccountLinksRequestBodyType' -> Bool # (/=) :: PostAccountLinksRequestBodyType' -> PostAccountLinksRequestBodyType' -> Bool #
Show PostAccountLinksRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods showsPrec :: Int -> PostAccountLinksRequestBodyType' -> ShowS # show :: PostAccountLinksRequestBodyType' -> String # showList :: [PostAccountLinksRequestBodyType'] -> ShowS #
ToJSON PostAccountLinksRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods toJSON :: PostAccountLinksRequestBodyType' -> Value # toEncoding :: PostAccountLinksRequestBodyType' -> Encoding # toJSONList :: [PostAccountLinksRequestBodyType'] -> Value # toEncodingList :: [PostAccountLinksRequestBodyType'] -> Encoding #
FromJSON PostAccountLinksRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods parseJSON :: Value -> Parser PostAccountLinksRequestBodyType' # parseJSONList :: Value -> Parser [PostAccountLinksRequestBodyType'] #

data PostAccountLinksResponse Source #

Represents a response of the operation postAccountLinks.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostAccountLinksResponseError is used.

Constructors

PostAccountLinksResponseError String	Means either no matching case available or a parse error
PostAccountLinksResponse200 AccountLink	Successful response.
PostAccountLinksResponseDefault Error	Error response.

Instances

Eq PostAccountLinksResponse Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods (==) :: PostAccountLinksResponse -> PostAccountLinksResponse -> Bool # (/=) :: PostAccountLinksResponse -> PostAccountLinksResponse -> Bool #
Show PostAccountLinksResponse Source #
Instance details Defined in StripeAPI.Operations.PostAccountLinks Methods showsPrec :: Int -> PostAccountLinksResponse -> ShowS # show :: PostAccountLinksResponse -> String # showList :: [PostAccountLinksResponse] -> ShowS #