StripeAPI.Operations.GetRecipientsId

pathId: Represents the parameter named 'id'

Constraints:

• Maximum length of 5000

queryExpand: Represents the parameter named 'expand'

Specifies which fields in the response should be expanded.

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

cards:

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

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

deleted: Always true for a deleted object

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

Constraints:

• Maximum length of 5000

email

Constraints:

• Maximum length of 5000

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

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

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.

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.

name: Full, legal name of the recipient.

Constraints:

• Maximum length of 5000

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

rolled_back_from

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

Constraints:

• Maximum length of 5000

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

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.

Constraints:

• Maximum length of 5000

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.

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

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

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

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

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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.

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

routing_number: The routing transit number for the bank account.

Constraints:

• Maximum length of 5000

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

data

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

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000