Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostAccountLinks

Contains the different functions to run the operation postAccountLinks

4 types
2 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourcePostAccountLinks.hs

valuepostAccountLinks

:: MonadHTTP m
=> PostAccountLinksRequestBody
The request body to send
-> ClientT 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>

datadata PostAccountLinksRequestBody

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

Constructors

PostAccountLinksRequestBody
- 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`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAccountLinksRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
Show PostAccountLinksRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
FromJSON PostAccountLinksRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
ToJSON PostAccountLinksRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks

valuemkPostAccountLinksRequestBody

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

Create a new PostAccountLinksRequestBody with all required fields.

datadata PostAccountLinksRequestBodyCollect'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAccountLinksRequestBodyCollect'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
Show PostAccountLinksRequestBodyCollect'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
FromJSON PostAccountLinksRequestBodyCollect'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
ToJSON PostAccountLinksRequestBodyCollect'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks

datadata PostAccountLinksRequestBodyType'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAccountLinksRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
Show PostAccountLinksRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
FromJSON PostAccountLinksRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
ToJSON PostAccountLinksRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks

datadata PostAccountLinksResponse

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.

Instances2Eq, Show

Eq PostAccountLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks
Show PostAccountLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAccountLinks