StripeAPI.Types.BankAccount

Contains the types generated from the schema BankAccount

Documentation

data BankAccount

Defines the object schema located at components.schemas.bank_account in the specification.

These bank accounts are payment methods on `Customer` objects.

On the other hand External Accounts are transfer destinations on `Account` objects for Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

Related guide: Bank Debits and Transfers.

Constructors

BankAccount

Fields

• bankAccountAccount :: Maybe BankAccountAccount'Variants

  account: The ID of the account that the bank account is associated with.

• bankAccountAccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• bankAccountAccountHolderType :: Maybe Text

  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

  Constraints:

  • Maximum length of 5000
• bankAccountAvailablePayoutMethods :: Maybe [BankAccountAvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• bankAccountBankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• bankAccountCountry :: Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• bankAccountCurrency :: Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• bankAccountCustomer :: Maybe BankAccountCustomer'Variants

  customer: The ID of the customer that the bank account is associated with.

• bankAccountDefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• bankAccountFingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  Constraints:

  • Maximum length of 5000
• bankAccountId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• bankAccountLast4 :: Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• bankAccountMetadata :: Maybe Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• bankAccountRoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• bankAccountStatus :: Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000

Instances

Eq BankAccount

Defined in StripeAPI.Types.BankAccount

Methods

(==) :: BankAccount -> BankAccount -> Bool

(/=) :: BankAccount -> BankAccount -> Bool

Show BankAccount

Defined in StripeAPI.Types.BankAccount

Methods

showsPrec :: Int -> BankAccount -> ShowS

show :: BankAccount -> String

showList :: [BankAccount] -> ShowS

ToJSON BankAccount

Defined in StripeAPI.Types.BankAccount

Methods

toJSON :: BankAccount -> Value

toEncoding :: BankAccount -> Encoding

toJSONList :: [BankAccount] -> Value

toEncodingList :: [BankAccount] -> Encoding

FromJSON BankAccount

Defined in StripeAPI.Types.BankAccount

Methods

parseJSON :: Value -> Parser BankAccount

parseJSONList :: Value -> Parser [BankAccount]

mkBankAccount

Arguments

:: Text

bankAccountCountry

-> Text

bankAccountCurrency

-> Text

bankAccountId

-> Text

bankAccountLast4

-> Text

bankAccountStatus

-> BankAccount

Create a new BankAccount with all required fields.

data BankAccountAccount'Variants

Defines the oneOf schema located at components.schemas.bank_account.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

BankAccountAccount'Text Text

BankAccountAccount'Account Account

Instances

Eq BankAccountAccount'Variants

Defined in StripeAPI.Types.BankAccount

Methods

(==) :: BankAccountAccount'Variants -> BankAccountAccount'Variants -> Bool

(/=) :: BankAccountAccount'Variants -> BankAccountAccount'Variants -> Bool

Show BankAccountAccount'Variants

Defined in StripeAPI.Types.BankAccount

Methods

showsPrec :: Int -> BankAccountAccount'Variants -> ShowS

show :: BankAccountAccount'Variants -> String

showList :: [BankAccountAccount'Variants] -> ShowS

ToJSON BankAccountAccount'Variants

Defined in StripeAPI.Types.BankAccount

Methods

toJSON :: BankAccountAccount'Variants -> Value

toEncoding :: BankAccountAccount'Variants -> Encoding

toJSONList :: [BankAccountAccount'Variants] -> Value

toEncodingList :: [BankAccountAccount'Variants] -> Encoding

FromJSON BankAccountAccount'Variants

Defined in StripeAPI.Types.BankAccount

Methods

parseJSON :: Value -> Parser BankAccountAccount'Variants

parseJSONList :: Value -> Parser [BankAccountAccount'Variants]

data BankAccountAvailablePayoutMethods'

Defines the enum schema located at components.schemas.bank_account.properties.available_payout_methods.items in the specification.

Constructors

BankAccountAvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

BankAccountAvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

BankAccountAvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

BankAccountAvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq BankAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.BankAccount

Methods

(==) :: BankAccountAvailablePayoutMethods' -> BankAccountAvailablePayoutMethods' -> Bool

(/=) :: BankAccountAvailablePayoutMethods' -> BankAccountAvailablePayoutMethods' -> Bool

Show BankAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.BankAccount

Methods

showsPrec :: Int -> BankAccountAvailablePayoutMethods' -> ShowS

show :: BankAccountAvailablePayoutMethods' -> String

showList :: [BankAccountAvailablePayoutMethods'] -> ShowS

ToJSON BankAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.BankAccount

Methods

toJSON :: BankAccountAvailablePayoutMethods' -> Value

toEncoding :: BankAccountAvailablePayoutMethods' -> Encoding

toJSONList :: [BankAccountAvailablePayoutMethods'] -> Value

toEncodingList :: [BankAccountAvailablePayoutMethods'] -> Encoding

FromJSON BankAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.BankAccount

Methods

parseJSON :: Value -> Parser BankAccountAvailablePayoutMethods'

parseJSONList :: Value -> Parser [BankAccountAvailablePayoutMethods']

data BankAccountCustomer'Variants

Defines the oneOf schema located at components.schemas.bank_account.properties.customer.anyOf in the specification.

The ID of the customer that the bank account is associated with.

Constructors

BankAccountCustomer'Text Text

BankAccountCustomer'Customer Customer

BankAccountCustomer'DeletedCustomer DeletedCustomer

Instances

Eq BankAccountCustomer'Variants

Defined in StripeAPI.Types.BankAccount

Methods

(==) :: BankAccountCustomer'Variants -> BankAccountCustomer'Variants -> Bool

(/=) :: BankAccountCustomer'Variants -> BankAccountCustomer'Variants -> Bool

Show BankAccountCustomer'Variants

Defined in StripeAPI.Types.BankAccount

Methods

showsPrec :: Int -> BankAccountCustomer'Variants -> ShowS

show :: BankAccountCustomer'Variants -> String

showList :: [BankAccountCustomer'Variants] -> ShowS

ToJSON BankAccountCustomer'Variants

Defined in StripeAPI.Types.BankAccount

Methods

toJSON :: BankAccountCustomer'Variants -> Value

toEncoding :: BankAccountCustomer'Variants -> Encoding

toJSONList :: [BankAccountCustomer'Variants] -> Value

toEncodingList :: [BankAccountCustomer'Variants] -> Encoding

FromJSON BankAccountCustomer'Variants

Defined in StripeAPI.Types.BankAccount

Methods

parseJSON :: Value -> Parser BankAccountCustomer'Variants

parseJSONList :: Value -> Parser [BankAccountCustomer'Variants]