Documentation

Fields

• getRecipientsIdResponseBody200ActiveAccount :: Maybe GetRecipientsIdResponseBody200ActiveAccount'

  active_account: Hash describing the current account on the recipient, if there is one.

• getRecipientsIdResponseBody200Cards :: Maybe GetRecipientsIdResponseBody200Cards'

  cards:

• getRecipientsIdResponseBody200Created :: Maybe Integer

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• getRecipientsIdResponseBody200DefaultCard :: Maybe GetRecipientsIdResponseBody200DefaultCard'Variants

  default_card: The default card to use for creating transfers to this recipient.

• getRecipientsIdResponseBody200Deleted :: Maybe GetRecipientsIdResponseBody200Deleted'

  deleted: Always true for a deleted object

• getRecipientsIdResponseBody200Description :: Maybe String

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200Email :: Maybe String

  email

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200Id :: Maybe String

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200Livemode :: Maybe Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• getRecipientsIdResponseBody200Metadata :: Maybe GetRecipientsIdResponseBody200Metadata'

  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.

• getRecipientsIdResponseBody200MigratedTo :: Maybe GetRecipientsIdResponseBody200MigratedTo'Variants

  migrated_to: The ID of the Custom account this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.

• getRecipientsIdResponseBody200Name :: Maybe String

  name: Full, legal name of the recipient.

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200Object :: Maybe GetRecipientsIdResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value.

• getRecipientsIdResponseBody200RolledBackFrom :: Maybe GetRecipientsIdResponseBody200RolledBackFrom'Variants

  rolled_back_from

• getRecipientsIdResponseBody200Type :: Maybe String

  type: Type of the recipient, one of `individual` or `corporation`.

  Constraints:

  • Maximum length of 5000

Fields

• getRecipientsIdResponseBody200ActiveAccount'Account :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Account'Variants

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

• getRecipientsIdResponseBody200ActiveAccount'AccountHolderName :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'AccountHolderType :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'BankName :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'Country :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'Currency :: Maybe String

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

• getRecipientsIdResponseBody200ActiveAccount'Customer :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants

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

• getRecipientsIdResponseBody200ActiveAccount'DefaultForCurrency :: Maybe Bool

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

• getRecipientsIdResponseBody200ActiveAccount'Fingerprint :: Maybe String

  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
• getRecipientsIdResponseBody200ActiveAccount'Id :: Maybe String

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'Last4 :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'Metadata :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Metadata'

  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.

• getRecipientsIdResponseBody200ActiveAccount'Object :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• getRecipientsIdResponseBody200ActiveAccount'RoutingNumber :: Maybe String

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• getRecipientsIdResponseBody200ActiveAccount'Status :: Maybe String

  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

Fields

• getRecipientsIdResponseBody200Cards'Data :: [] Card

  data

• getRecipientsIdResponseBody200Cards'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getRecipientsIdResponseBody200Cards'Object :: GetRecipientsIdResponseBody200Cards'Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getRecipientsIdResponseBody200Cards'Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000