Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.FinancialConnections_Session

Contains the types generated from the schema FinancialConnections_Session

Synopsis

data FinancialConnections'session
value mkFinancialConnections'session
data FinancialConnections'sessionAccountHolder'NonNullable
value mkFinancialConnections'sessionAccountHolder'NonNullable
data FinancialConnections'sessionAccountHolder'NonNullableAccount'Variants
data FinancialConnections'sessionAccountHolder'NonNullableCustomer'Variants
data FinancialConnections'sessionAccountHolder'NonNullableType'
data FinancialConnections'sessionAccounts'
value mkFinancialConnections'sessionAccounts'
data FinancialConnections'sessionPermissions'

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceFinancialConnections_Session.hs

datadata FinancialConnections'session

Defines the object schema located at components.schemas.financial_connections.session in the specification.

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Constructors

FinancialConnections'session
- financialConnections'sessionAccountHolder :: Maybe (Nullable FinancialConnections'sessionAccountHolder'NonNullable)
  account_holder: The account holder for whom accounts are collected in this session.
- financialConnections'sessionAccounts :: FinancialConnections'sessionAccounts'
  accounts: The accounts that were collected as part of this Session.
- financialConnections'sessionClientSecret :: Text
  client_secret: A value that will be passed to the client to launch the authentication flow.
  Constraints:
  - Maximum length of 5000
- financialConnections'sessionFilters :: Maybe BankConnectionsResourceLinkAccountSessionFilters
  filters:
- financialConnections'sessionId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- financialConnections'sessionLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- financialConnections'sessionPermissions :: [FinancialConnections'sessionPermissions']
  permissions: Permissions requested for accounts collected during this session.
- financialConnections'sessionReturnUrl :: Maybe Text
  return_url: For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

valuemkFinancialConnections'session

:: FinancialConnections'sessionAccounts'
financialConnections'sessionAccounts
-> Text
financialConnections'sessionClientSecret
-> Text
financialConnections'sessionId
-> Bool
financialConnections'sessionLivemode
-> [FinancialConnections'sessionPermissions']
financialConnections'sessionPermissions
-> FinancialConnections'session

Source#

Create a new FinancialConnections'session with all required fields.

datadata FinancialConnections'sessionAccountHolder'NonNullable

Source#

Defines the object schema located at components.schemas.financial_connections.session.properties.account_holder.anyOf in the specification.

The account holder for whom accounts are collected in this session.

Constructors

FinancialConnections'sessionAccountHolder'NonNullable
- financialConnections'sessionAccountHolder'NonNullableAccount :: Maybe FinancialConnections'sessionAccountHolder'NonNullableAccount'Variants
  account: The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
- financialConnections'sessionAccountHolder'NonNullableCustomer :: Maybe FinancialConnections'sessionAccountHolder'NonNullableCustomer'Variants
  customer: ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
- financialConnections'sessionAccountHolder'NonNullableType :: Maybe FinancialConnections'sessionAccountHolder'NonNullableType'
  type: Type of account holder that this account belongs to.

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionAccountHolder'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionAccountHolder'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionAccountHolder'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionAccountHolder'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

valuemkFinancialConnections'sessionAccountHolder'NonNullable :: FinancialConnections'sessionAccountHolder'NonNullable

Source#

Create a new FinancialConnections'sessionAccountHolder'NonNullable with all required fields.

datadata FinancialConnections'sessionAccountHolder'NonNullableAccount'Variants

Source#

Defines the oneOf schema located at components.schemas.financial_connections.session.properties.account_holder.anyOf.properties.account.anyOf in the specification.

The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.

Constructors

FinancialConnections'sessionAccountHolder'NonNullableAccount'Text Text
FinancialConnections'sessionAccountHolder'NonNullableAccount'Account Account

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionAccountHolder'NonNullableAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionAccountHolder'NonNullableAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionAccountHolder'NonNullableAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionAccountHolder'NonNullableAccount'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

datadata FinancialConnections'sessionAccountHolder'NonNullableCustomer'Variants

Source#

Defines the oneOf schema located at components.schemas.financial_connections.session.properties.account_holder.anyOf.properties.customer.anyOf in the specification.

ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.

Constructors

FinancialConnections'sessionAccountHolder'NonNullableCustomer'Text Text
FinancialConnections'sessionAccountHolder'NonNullableCustomer'Customer Customer

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionAccountHolder'NonNullableCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionAccountHolder'NonNullableCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionAccountHolder'NonNullableCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionAccountHolder'NonNullableCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

datadata FinancialConnections'sessionAccountHolder'NonNullableType'

Source#

Defines the enum schema located at components.schemas.financial_connections.session.properties.account_holder.anyOf.properties.type in the specification.

Type of account holder that this account belongs to.

Constructors

FinancialConnections'sessionAccountHolder'NonNullableType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
FinancialConnections'sessionAccountHolder'NonNullableType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
FinancialConnections'sessionAccountHolder'NonNullableType'EnumAccount
Represents the JSON value "account"
FinancialConnections'sessionAccountHolder'NonNullableType'EnumCustomer
Represents the JSON value "customer"

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionAccountHolder'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionAccountHolder'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionAccountHolder'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionAccountHolder'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

datadata FinancialConnections'sessionAccounts'

Source#

Defines the object schema located at components.schemas.financial_connections.session.properties.accounts in the specification.

The accounts that were collected as part of this Session.

Constructors

FinancialConnections'sessionAccounts'
- financialConnections'sessionAccounts'Data :: [FinancialConnections'account]
  data: Details about each object.
- financialConnections'sessionAccounts'HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- financialConnections'sessionAccounts'Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/financial_connections/accounts'

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionAccounts'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionAccounts'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionAccounts'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionAccounts'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session

valuemkFinancialConnections'sessionAccounts'

:: [FinancialConnections'account]
financialConnections'sessionAccounts'Data
-> Bool
financialConnections'sessionAccounts'HasMore
-> Text
financialConnections'sessionAccounts'Url
-> FinancialConnections'sessionAccounts'

Source#

Create a new FinancialConnections'sessionAccounts' with all required fields.

datadata FinancialConnections'sessionPermissions'

Source#

Defines the enum schema located at components.schemas.financial_connections.session.properties.permissions.items in the specification.

Constructors

FinancialConnections'sessionPermissions'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
FinancialConnections'sessionPermissions'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
FinancialConnections'sessionPermissions'EnumBalances
Represents the JSON value "balances"
FinancialConnections'sessionPermissions'EnumOwnership
Represents the JSON value "ownership"
FinancialConnections'sessionPermissions'EnumPaymentMethod
Represents the JSON value "payment_method"
FinancialConnections'sessionPermissions'EnumTransactions
Represents the JSON value "transactions"

Instances4Eq, Show, FromJSON, ToJSON

Eq FinancialConnections'sessionPermissions'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
Show FinancialConnections'sessionPermissions'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
FromJSON FinancialConnections'sessionPermissions'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session
ToJSON FinancialConnections'sessionPermissions'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.FinancialConnections_Session