Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostAccountLinks

Description

Contains the different functions to run the operation postAccountLinks

Synopsis

postAccountLinks :: forall m. MonadHTTP m => PostAccountLinksRequestBody -> StripeT m (Response PostAccountLinksResponse)
data PostAccountLinksRequestBody = PostAccountLinksRequestBody {
}
mkPostAccountLinksRequestBody :: Text -> PostAccountLinksRequestBodyType' -> PostAccountLinksRequestBody
data PostAccountLinksRequestBodyCollect'
data PostAccountLinksRequestBodyType'
data PostAccountLinksResponse

Documentation

postAccountLinks Source #

Arguments

:: forall m. MonadHTTP m
=> PostAccountLinksRequestBody	The request body to send
-> StripeT m (Response PostAccountLinksResponse)	Monadic computation which returns the result of the operation

POST /v1/account_links

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

data PostAccountLinksRequestBody Source #

Defines the object schema located at paths./v1/account_links.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostAccountLinksRequestBody

Fields

postAccountLinksRequestBodyAccount :: Text
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 [Text]
expand: Specifies which fields in the response should be expanded.
postAccountLinksRequestBodyRefreshUrl :: Maybe Text
refresh_url: The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
postAccountLinksRequestBodyReturnUrl :: Maybe Text
return_url: The URL that the user will be redirected to upon leaving or completing the linked flow.
postAccountLinksRequestBodyType :: PostAccountLinksRequestBodyType'
type: The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.

Instances

Instances details

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] #

mkPostAccountLinksRequestBody Source #

Arguments

:: Text	`postAccountLinksRequestBodyAccount`
-> PostAccountLinksRequestBodyType'	`postAccountLinksRequestBodyType`
-> PostAccountLinksRequestBody

Create a new PostAccountLinksRequestBody with all required fields.

data PostAccountLinksRequestBodyCollect' Source #

Defines the enum schema located at paths./v1/account_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collect in the specification.

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

Constructors

PostAccountLinksRequestBodyCollect'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostAccountLinksRequestBodyCollect'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostAccountLinksRequestBodyCollect'EnumCurrentlyDue	Represents the JSON value `"currently_due"`
PostAccountLinksRequestBodyCollect'EnumEventuallyDue	Represents the JSON value `"eventually_due"`

Instances

Instances details

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 located at paths./v1/account_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.type in the specification.

The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.

Constructors

PostAccountLinksRequestBodyType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostAccountLinksRequestBodyType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostAccountLinksRequestBodyType'EnumAccountOnboarding	Represents the JSON value `"account_onboarding"`
PostAccountLinksRequestBodyType'EnumAccountUpdate	Represents the JSON value `"account_update"`

Instances

Instances details

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

Instances details

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 #