Stripe

GET

/v1/3d_secure/{three_d_secure}

Retrieves a 3D Secure object.

Request

Path

Name	Data Type	Description
`three_d_secure`	string	The identifier of the 3D Secure object to be retrieved.

Query

Name	Data Type	Description
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`ThreeDSecure`	object

Properties


                        status

string

Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.


                        redirect_url

string

If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".


                        object

string
Allowed values:
- three_d_secure

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


                        livemode

boolean

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

id

string

Unique identifier for the object.


                        currency

string

Three-letter ISO currency code, in lowercase. Must be a supported currency.


                        created

integer

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

card card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.


                        authenticated

boolean

True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.

amount integer

POST

/v1/3d_secure

Initiate 3D Secure authentication.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`return_url`	string	The URL that the cardholder's browser will be returned to when authentication completes.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`customer`	string
`currency`	string	Three-letter ISO currency code, in lowercase. Must be a supported currency.
`card`	string	The ID of a card token, or the ID of a card belonging to the given customer.
`amount`	integer	Amount of the charge that you will create when authentication completes.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`ThreeDSecure`	object

Properties


                        status

string

Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.


                        redirect_url

string

If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".


                        object

string
Allowed values:
- three_d_secure

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


                        livemode

boolean

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

id

string

Unique identifier for the object.


                        currency

string

Three-letter ISO currency code, in lowercase. Must be a supported currency.


                        created

integer

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

card card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.


                        authenticated

boolean

True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.

amount integer

DELETE

/v1/account/bank_accounts/{id}

Delete a specified external account for a given account.

Request

Path

Name	Data Type	Description
`id`	string	The ID of the external account to be deleted.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`id`	string	Unique identifier for the object.
`deleted`	boolean Allowed values: - `1`	Always true for a deleted object
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.

GET

/v1/account/bank_accounts/{id}

Retrieve a specified external account for a given account.

Request

Path

Name	Data Type	Description
`id`	string

Query

Name	Data Type	Description
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

POST

/v1/account/bank_accounts/{id}

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Request

Path

Name	Data Type	Description
`id`	string	The ID of the external account to update

Body

Name	Data Type	Description
`payload`	object

Properties

`name`	string	Cardholder name.
`metadata`	object
`expand`	array [string]	Specifies which fields in the response should be expanded.
`exp_year`	string	Four digit number representing the card’s expiration year.
`exp_month`	string	Two digit number representing the card’s expiration month.
`default_for_currency`	boolean	When set to true, this becomes the default external account for its currency.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account_holder_type`	string Allowed values: - - `company` - `individual`	The type of entity that holds the account. This can be either `individual` or `company`.
`account_holder_name`	string	The name of the person or business that owns the bank account.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

POST

/v1/account/bank_accounts

Create an external account for a given account.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`metadata`	object	A set of key-value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format.
`external_account`		This string to be replaced by DocSpecGenerator.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`default_for_currency`	boolean	When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
`bank_account`		Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

DELETE

/v1/account/external_accounts/{id}

Delete a specified external account for a given account.

Request

Path

Name	Data Type	Description
`id`	string	The ID of the external account to be deleted.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`id`	string	Unique identifier for the object.
`deleted`	boolean Allowed values: - `1`	Always true for a deleted object
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.

GET

/v1/account/external_accounts/{id}

Retrieve a specified external account for a given account.

Request

Path

Name	Data Type	Description
`id`	string

Query

Name	Data Type	Description
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

POST

/v1/account/external_accounts/{id}

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Request

Path

Name	Data Type	Description
`id`	string	The ID of the external account to update

Body

Name	Data Type	Description
`payload`	object

Properties

`name`	string	Cardholder name.
`metadata`	object
`expand`	array [string]	Specifies which fields in the response should be expanded.
`exp_year`	string	Four digit number representing the card’s expiration year.
`exp_month`	string	Two digit number representing the card’s expiration month.
`default_for_currency`	boolean	When set to true, this becomes the default external account for its currency.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account_holder_type`	string Allowed values: - - `company` - `individual`	The type of entity that holds the account. This can be either `individual` or `company`.
`account_holder_name`	string	The name of the person or business that owns the bank account.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

GET

/v1/account/external_accounts

List external accounts for an account.

Request

Query

Name	Data Type	Description
`starting_after`	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
`limit`	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`ending_before`	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`ExternalAccountList`	object

Properties

url

string

The URL where this list can be accessed.


                        object

string
Allowed values:
- list

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


                        has_more

boolean

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


                        data

array [bank_account]

The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.

BankAccount object

Properties

`status`	string	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.
`routing_number`	string	The routing transit number for the bank account.
`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`bank_name`	string	Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
`account_holder_type`	string	The type of entity that holds the account. This can be either `individual` or `company`.
`account_holder_name`	string	The name of the person or business that owns the bank account.
`account`	string

POST

/v1/account/external_accounts

Create an external account for a given account.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`metadata`	object	A set of key-value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format.
`external_account`		This string to be replaced by DocSpecGenerator.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`default_for_currency`	boolean	When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
`bank_account`		Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Polymorphic`	object

Properties

`object`	string Allowed values: - `bank_account`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`last4`	string
`id`	string	Unique identifier for the object.
`fingerprint`	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
`default_for_currency`	boolean	Whether this bank account is the default external account for its currency.
`customer`	string
`currency`	string	Three-letter ISO code for the currency paid out to the bank account.
`country`	string	Two-letter ISO code representing the country the bank account is located in.
`account`	string

POST

/v1/account/login_links

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`redirect_url`	string	Where to redirect the user after they log out of their dashboard.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`account`	string	The identifier of the account to create a login link for.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`LoginLink`	object

Properties

`url`	string	The URL for the login link.
`object`	string Allowed values: - `login_link`	String representing the object's type. Objects of the same type share the same value.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.

PUT

/v1/account/logout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out Express accounts connected to your platform.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`expand`	array [string]	Specifies which fields in the response should be expanded.
`account`	string	The identifier of the account to log out.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`LightAccountLogout`	object

DELETE

/v1/account/people/{person}

Deletes an existing person’s relationship to the account’s legal entity.

Request

Path

Name	Data Type	Description
`person`	string	The ID of the person to be deleted.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`DeletedPerson`	object

Properties

`object`	string Allowed values: - `person`	String representing the object's type. Objects of the same type share the same value.
`id`	string	Unique identifier for the object.
`deleted`	boolean Allowed values: - `1`	Always true for a deleted object

GET

/v1/account/people/{person}

Retrieves an existing person.

Request

Path

Name	Data Type	Description
`person`	string	The ID of a person to retrieve.

Query

Name	Data Type	Description
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Person`	object

Properties

verification legal_entity_verification

LegalEntityVerification object

Properties

`status`	string	The state of verification for this legal entity. Possible values are `unverified`, `pending`, or `verified`.
`document_back`	string	(ID of a file upload) A photo (jpg or png) of the back of an identifying document, either a passport or local ID card.
`document`	string	(ID of a file upload) A photo (jpg or png) of the front of an identifying document, either a passport or local ID card.
`details_code`	string	A machine-readable code specifying the verification state for this legal entity. One of `scan_corrupt`, `scan_not_readable`, `scan_failed_greyscale`, `scan_not_uploaded`, `scan_id_type_not_supported`, `scan_id_country_not_supported`, `scan_failed_other`, or `scan_failed_test_mode`.
`details`	string	A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".


                        ssn_last_4_provided

boolean

Whether the last 4 digits of this person's SSN have been provided.

requirements person_requirements

PersonRequirements object

Properties

`past_due`	array [string]	Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account.
`eventually_due`	array [string]	Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set.
`currently_due`	array [string]	Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields are moved to `past_due` and the account is disabled.

relationship person_relationship

PersonRelationship object

Properties

`title`	string	The person's title (e.g., CEO, Support Engineer).
`percent_ownership`	double	The percent owned by the person of the account's legal entity.
`owner`	boolean	Whether the person is an owner of the account’s legal entity.
`director`	boolean	Whether the person is a director of the account's legal entity.
`account_opener`	boolean	Whether the person opened the account. This person provides information about themselves, and general information about the account.


                        phone

string

The person's phone number.


                        object

string
Allowed values:
- person

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


                        metadata

object

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.


                        maiden_name

string

The person's maiden name.


                        last_name_kanji

string

The Kanji variation of the person's last name (Japan only).


                        last_name_kana

string

The Kana variation of the person's last name (Japan only).


                        last_name

string

The person's last name.


                        id_number_provided

boolean

Whether the person's id_number was provided.

id

string

Unique identifier for the object.


                        gender

string

The person's gender (International regulations require either "male" or "female").


                        first_name_kanji

string

The Kanji variation of the person's first name (Japan only).


                        first_name_kana

string

The Kana variation of the person's first name (Japan only).


                        first_name

string

The person's first name.


                        email

string

The person's email address.

dob legal_entity_dob

LegalEntityDOB object

Properties

`year`	integer	The four-digit year of birth.
`month`	integer	The month of birth, between 1 and 12.
`day`	integer	The day of birth, between 1 and 31.


                        created

integer

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

address_kanji legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address_kana legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address address

Address object

Properties

`state`	string	State/County/Province/Region.
`postal_code`	string	ZIP or postal code.
`line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`line1`	string	Address line 1 (Street address/PO Box/Company name).
`country`	string	2-letter country code.
`city`	string	City/District/Suburb/Town/Village.


                        account

string

The account the person is associated with.

POST

/v1/account/people/{person}

Updates an existing person.

Request

Path

Name	Data Type	Description
`person`	string	The ID of a person to update.

Body

Name	Data Type	Description
`payload`	object

Properties

`ssn_last_4`	string	The last 4 digits of the person's social security number.
`relationship`
`phone`	string	The person's phone number.
`metadata`	object	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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
`maiden_name`	string	The person's maiden name.
`last_name_kanji`	string	The Kanji variation of the person's last name (Japan only).
`last_name_kana`	string	The Kana variation of the person's last name (Japan only).
`last_name`	string	The person's last name.
`id_number`	string	The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
`gender`	string	The person's gender (International regulations require either "male" or "female").
`first_name_kanji`	string	The Kanji variation of the person's first name (Japan only).
`first_name_kana`	string	The Kana variation of the person's first name (Japan only).
`first_name`	string	The person's first name.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`email`	string	The person's email address.
`dob`
`address_kanji`
`address_kana`
`address`

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Person`	object

Properties

verification legal_entity_verification

LegalEntityVerification object

Properties

`status`	string	The state of verification for this legal entity. Possible values are `unverified`, `pending`, or `verified`.
`document_back`	string	(ID of a file upload) A photo (jpg or png) of the back of an identifying document, either a passport or local ID card.
`document`	string	(ID of a file upload) A photo (jpg or png) of the front of an identifying document, either a passport or local ID card.
`details_code`	string	A machine-readable code specifying the verification state for this legal entity. One of `scan_corrupt`, `scan_not_readable`, `scan_failed_greyscale`, `scan_not_uploaded`, `scan_id_type_not_supported`, `scan_id_country_not_supported`, `scan_failed_other`, or `scan_failed_test_mode`.
`details`	string	A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".


                        ssn_last_4_provided

boolean

Whether the last 4 digits of this person's SSN have been provided.

requirements person_requirements

PersonRequirements object

Properties

`past_due`	array [string]	Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account.
`eventually_due`	array [string]	Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set.
`currently_due`	array [string]	Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields are moved to `past_due` and the account is disabled.

relationship person_relationship

PersonRelationship object

Properties

`title`	string	The person's title (e.g., CEO, Support Engineer).
`percent_ownership`	double	The percent owned by the person of the account's legal entity.
`owner`	boolean	Whether the person is an owner of the account’s legal entity.
`director`	boolean	Whether the person is a director of the account's legal entity.
`account_opener`	boolean	Whether the person opened the account. This person provides information about themselves, and general information about the account.


                        phone

string

The person's phone number.


                        object

string
Allowed values:
- person

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


                        metadata

object

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.


                        maiden_name

string

The person's maiden name.


                        last_name_kanji

string

The Kanji variation of the person's last name (Japan only).


                        last_name_kana

string

The Kana variation of the person's last name (Japan only).


                        last_name

string

The person's last name.


                        id_number_provided

boolean

Whether the person's id_number was provided.

id

string

Unique identifier for the object.


                        gender

string

The person's gender (International regulations require either "male" or "female").


                        first_name_kanji

string

The Kanji variation of the person's first name (Japan only).


                        first_name_kana

string

The Kana variation of the person's first name (Japan only).


                        first_name

string

The person's first name.


                        email

string

The person's email address.

dob legal_entity_dob

LegalEntityDOB object

Properties

`year`	integer	The four-digit year of birth.
`month`	integer	The month of birth, between 1 and 12.
`day`	integer	The day of birth, between 1 and 31.


                        created

integer

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

address_kanji legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address_kana legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address address

Address object

Properties

`state`	string	State/County/Province/Region.
`postal_code`	string	ZIP or postal code.
`line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`line1`	string	Address line 1 (Street address/PO Box/Company name).
`country`	string	2-letter country code.
`city`	string	City/District/Suburb/Town/Village.


                        account

string

The account the person is associated with.

GET

/v1/account/people

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Request

Query

Name	Data Type	Description
`starting_after`	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
`relationship`	string	Filters on the list of people returned based on the person's relationship to the account's company.
`limit`	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`ending_before`	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`body`	object

Properties

url

string

The URL where this list can be accessed.


                        object

string
Allowed values:
- list

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


                        has_more

boolean

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

data array [person]

Person object

Properties

verification legal_entity_verification

LegalEntityVerification object

Properties

`status`	string	The state of verification for this legal entity. Possible values are `unverified`, `pending`, or `verified`.
`document_back`	string	(ID of a file upload) A photo (jpg or png) of the back of an identifying document, either a passport or local ID card.
`document`	string	(ID of a file upload) A photo (jpg or png) of the front of an identifying document, either a passport or local ID card.
`details_code`	string	A machine-readable code specifying the verification state for this legal entity. One of `scan_corrupt`, `scan_not_readable`, `scan_failed_greyscale`, `scan_not_uploaded`, `scan_id_type_not_supported`, `scan_id_country_not_supported`, `scan_failed_other`, or `scan_failed_test_mode`.
`details`	string	A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".


                        ssn_last_4_provided

boolean

Whether the last 4 digits of this person's SSN have been provided.

requirements person_requirements

PersonRequirements object

Properties

`past_due`	array [string]	Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account.
`eventually_due`	array [string]	Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set.
`currently_due`	array [string]	Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields are moved to `past_due` and the account is disabled.

relationship person_relationship

PersonRelationship object

Properties

`title`	string	The person's title (e.g., CEO, Support Engineer).
`percent_ownership`	double	The percent owned by the person of the account's legal entity.
`owner`	boolean	Whether the person is an owner of the account’s legal entity.
`director`	boolean	Whether the person is a director of the account's legal entity.
`account_opener`	boolean	Whether the person opened the account. This person provides information about themselves, and general information about the account.


                        phone

string

The person's phone number.


                        object

string
Allowed values:
- person

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


                        metadata

object

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.


                        maiden_name

string

The person's maiden name.


                        last_name_kanji

string

The Kanji variation of the person's last name (Japan only).


                        last_name_kana

string

The Kana variation of the person's last name (Japan only).


                        last_name

string

The person's last name.


                        id_number_provided

boolean

Whether the person's id_number was provided.

id

string

Unique identifier for the object.


                        gender

string

The person's gender (International regulations require either "male" or "female").


                        first_name_kanji

string

The Kanji variation of the person's first name (Japan only).


                        first_name_kana

string

The Kana variation of the person's first name (Japan only).


                        first_name

string

The person's first name.


                        email

string

The person's email address.

dob legal_entity_dob

LegalEntityDOB object

Properties

`year`	integer	The four-digit year of birth.
`month`	integer	The month of birth, between 1 and 12.
`day`	integer	The day of birth, between 1 and 31.


                        created

integer

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

address_kanji legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address_kana legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address address

Address object

Properties

`state`	string	State/County/Province/Region.
`postal_code`	string	ZIP or postal code.
`line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`line1`	string	Address line 1 (Street address/PO Box/Company name).
`country`	string	2-letter country code.
`city`	string	City/District/Suburb/Town/Village.


                        account

string

The account the person is associated with.

POST

/v1/account/people

Creates a new person.

Request

Body

Name	Data Type	Description
`payload`	object

Properties

`ssn_last_4`	string	The last 4 digits of the person's social security number.
`relationship`
`phone`	string	The person's phone number.
`metadata`	object	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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
`maiden_name`	string	The person's maiden name.
`last_name_kanji`	string	The Kanji variation of the person's last name (Japan only).
`last_name_kana`	string	The Kana variation of the person's last name (Japan only).
`last_name`	string	The person's last name.
`id_number`	string	The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
`gender`	string	The person's gender (International regulations require either "male" or "female").
`first_name_kanji`	string	The Kanji variation of the person's first name (Japan only).
`first_name_kana`	string	The Kana variation of the person's first name (Japan only).
`first_name`	string	The person's first name.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`email`	string	The person's email address.
`dob`
`address_kanji`
`address_kana`
`address`

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Person`	object

Properties

verification legal_entity_verification

LegalEntityVerification object

Properties

`status`	string	The state of verification for this legal entity. Possible values are `unverified`, `pending`, or `verified`.
`document_back`	string	(ID of a file upload) A photo (jpg or png) of the back of an identifying document, either a passport or local ID card.
`document`	string	(ID of a file upload) A photo (jpg or png) of the front of an identifying document, either a passport or local ID card.
`details_code`	string	A machine-readable code specifying the verification state for this legal entity. One of `scan_corrupt`, `scan_not_readable`, `scan_failed_greyscale`, `scan_not_uploaded`, `scan_id_type_not_supported`, `scan_id_country_not_supported`, `scan_failed_other`, or `scan_failed_test_mode`.
`details`	string	A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".


                        ssn_last_4_provided

boolean

Whether the last 4 digits of this person's SSN have been provided.

requirements person_requirements

PersonRequirements object

Properties

`past_due`	array [string]	Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account.
`eventually_due`	array [string]	Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set.
`currently_due`	array [string]	Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields are moved to `past_due` and the account is disabled.

relationship person_relationship

PersonRelationship object

Properties

`title`	string	The person's title (e.g., CEO, Support Engineer).
`percent_ownership`	double	The percent owned by the person of the account's legal entity.
`owner`	boolean	Whether the person is an owner of the account’s legal entity.
`director`	boolean	Whether the person is a director of the account's legal entity.
`account_opener`	boolean	Whether the person opened the account. This person provides information about themselves, and general information about the account.


                        phone

string

The person's phone number.


                        object

string
Allowed values:
- person

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


                        metadata

object

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.


                        maiden_name

string

The person's maiden name.


                        last_name_kanji

string

The Kanji variation of the person's last name (Japan only).


                        last_name_kana

string

The Kana variation of the person's last name (Japan only).


                        last_name

string

The person's last name.


                        id_number_provided

boolean

Whether the person's id_number was provided.

id

string

Unique identifier for the object.


                        gender

string

The person's gender (International regulations require either "male" or "female").


                        first_name_kanji

string

The Kanji variation of the person's first name (Japan only).


                        first_name_kana

string

The Kana variation of the person's first name (Japan only).


                        first_name

string

The person's first name.


                        email

string

The person's email address.

dob legal_entity_dob

LegalEntityDOB object

Properties

`year`	integer	The four-digit year of birth.
`month`	integer	The month of birth, between 1 and 12.
`day`	integer	The day of birth, between 1 and 31.


                        created

integer

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

address_kanji legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address_kana legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address address

Address object

Properties

`state`	string	State/County/Province/Region.
`postal_code`	string	ZIP or postal code.
`line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`line1`	string	Address line 1 (Street address/PO Box/Company name).
`country`	string	2-letter country code.
`city`	string	City/District/Suburb/Town/Village.


                        account

string

The account the person is associated with.

DELETE

/v1/account/persons/{person}

Deletes an existing person’s relationship to the account’s legal entity.

Request

Path

Name	Data Type	Description
`person`	string	The ID of the person to be deleted.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`DeletedPerson`	object

Properties

`object`	string Allowed values: - `person`	String representing the object's type. Objects of the same type share the same value.
`id`	string	Unique identifier for the object.
`deleted`	boolean Allowed values: - `1`	Always true for a deleted object

GET

/v1/account/persons/{person}

Retrieves an existing person.

Request

Path

Name	Data Type	Description
`person`	string	The ID of a person to retrieve.

Query

Name	Data Type	Description
`expand`	array	Specifies which fields in the response should be expanded.

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
`brand`	string	Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
`available_payout_methods`	array [string]	A set of available payout methods for this card. Will be either `["standard"]` or `["standard", "instant"]`. Only values from this set should be passed as the `method` when creating a transfer.
`address_zip_check`	string	If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_zip`	string	ZIP or postal code.
`address_state`	string	State/County/Province/Region.
`address_line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`address_line1_check`	string	If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`address_line1`	string	Address line 1 (Street address/PO Box/Company name).
`address_country`	string	Billing address country, if provided when creating card.
`address_city`	string	City/District/Suburb/Town/Village.
`account`	string	The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

payment_method payment_method

PaymentMethod object

Properties

`type`	string Allowed values: - `card`	The type of the PaymentMethod, one of `card`. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
`object`	string Allowed values: - `payment_method`	String representing the object's type. Objects of the same type share the same value.
`metadata`	object	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.
`livemode`	boolean	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`id`	string	Unique identifier for the object.
`customer`	string	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
`created`	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`card`	payment_flows_private_payment_methods_card
`billing_details`	payment_flows_payment_method_resource_billing_details


                        param

string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.


                        message

string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.


                        doc_url

string

A URL to more information about the error code reported.


                        decline_code

string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.


                        code

string

For some errors that could be handled programmatically, a short string indicating the error code reported.


                        charge

string

For card errors, the ID of the failed charge.

200Successful response.

Body

Name	Data Type	Description
`Person`	object

Properties

verification legal_entity_verification

LegalEntityVerification object

Properties

`status`	string	The state of verification for this legal entity. Possible values are `unverified`, `pending`, or `verified`.
`document_back`	string	(ID of a file upload) A photo (jpg or png) of the back of an identifying document, either a passport or local ID card.
`document`	string	(ID of a file upload) A photo (jpg or png) of the front of an identifying document, either a passport or local ID card.
`details_code`	string	A machine-readable code specifying the verification state for this legal entity. One of `scan_corrupt`, `scan_not_readable`, `scan_failed_greyscale`, `scan_not_uploaded`, `scan_id_type_not_supported`, `scan_id_country_not_supported`, `scan_failed_other`, or `scan_failed_test_mode`.
`details`	string	A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".


                        ssn_last_4_provided

boolean

Whether the last 4 digits of this person's SSN have been provided.

requirements person_requirements

PersonRequirements object

Properties

`past_due`	array [string]	Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable payouts for the person's account.
`eventually_due`	array [string]	Fields that need to be collected assuming all volume thresholds are reached. As fields are needed, they are moved to `currently_due` and the account's `current_deadline` is set.
`currently_due`	array [string]	Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields are moved to `past_due` and the account is disabled.

relationship person_relationship

PersonRelationship object

Properties

`title`	string	The person's title (e.g., CEO, Support Engineer).
`percent_ownership`	double	The percent owned by the person of the account's legal entity.
`owner`	boolean	Whether the person is an owner of the account’s legal entity.
`director`	boolean	Whether the person is a director of the account's legal entity.
`account_opener`	boolean	Whether the person opened the account. This person provides information about themselves, and general information about the account.


                        phone

string

The person's phone number.


                        object

string
Allowed values:
- person

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


                        metadata

object

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.


                        maiden_name

string

The person's maiden name.


                        last_name_kanji

string

The Kanji variation of the person's last name (Japan only).


                        last_name_kana

string

The Kana variation of the person's last name (Japan only).


                        last_name

string

The person's last name.


                        id_number_provided

boolean

Whether the person's id_number was provided.

id

string

Unique identifier for the object.


                        gender

string

The person's gender (International regulations require either "male" or "female").


                        first_name_kanji

string

The Kanji variation of the person's first name (Japan only).


                        first_name_kana

string

The Kana variation of the person's first name (Japan only).


                        first_name

string

The person's first name.


                        email

string

The person's email address.

dob legal_entity_dob

LegalEntityDOB object

Properties

`year`	integer	The four-digit year of birth.
`month`	integer	The month of birth, between 1 and 12.
`day`	integer	The day of birth, between 1 and 31.


                        created

integer

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

address_kanji legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address_kana legal_entity_japan_address

LegalEntityJapanAddress object

Properties

`town`	string	Town/cho-me.
`state`	string	Prefecture.
`postal_code`	string	Zip/Postal Code.
`line2`	string	Building details.
`line1`	string	Block/Building number.
`country`	string	Two-letter country code (ISO 3166-1 alpha-2).
`city`	string	City/Ward.

address address

Address object

Properties

`state`	string	State/County/Province/Region.
`postal_code`	string	ZIP or postal code.
`line2`	string	Address line 2 (Apartment/Suite/Unit/Building).
`line1`	string	Address line 1 (Street address/PO Box/Company name).
`country`	string	2-letter country code.
`city`	string	City/District/Suburb/Town/Village.


                        account

string

The account the person is associated with.

POST

/v1/account/persons/{person}

Updates an existing person.

Request

Path

Name	Data Type	Description
`person`	string	The ID of a person to update.

Body

Name	Data Type	Description
`payload`	object

Properties

`ssn_last_4`	string	The last 4 digits of the person's social security number.
`relationship`
`phone`	string	The person's phone number.
`metadata`	object	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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
`maiden_name`	string	The person's maiden name.
`last_name_kanji`	string	The Kanji variation of the person's last name (Japan only).
`last_name_kana`	string	The Kana variation of the person's last name (Japan only).
`last_name`	string	The person's last name.
`id_number`	string	The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
`gender`	string	The person's gender (International regulations require either "male" or "female").
`first_name_kanji`	string	The Kanji variation of the person's first name (Japan only).
`first_name_kana`	string	The Kana variation of the person's first name (Japan only).
`first_name`	string	The person's first name.
`expand`	array [string]	Specifies which fields in the response should be expanded.
`email`	string	The person's email address.
`dob`
`address_kanji`
`address_kana`
`address`

Responses

200Error response.

Body

Name	Data Type	Description
`error`	object	An error response from the Stripe API

Properties

error api_errors

APIErrors object

Properties


                        type

string
Allowed values:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error

The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error

source card

Card object

Properties

`tokenization_method`	string	If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
`recipient`	string	The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
`object`	string Allowed values: - `card`	String representing the object's type. Objects of the same type share the same value.
`name`	string	Cardholder name.
`metadata`	object	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.
`last4`	string	The last four digits of the card.
`id`	string	Unique identifier for the object.
`funding`	string	Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
`fingerprint`	string	Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
`exp_year`	integer	Four-digit number representing the card's expiration year.
`exp_month`	integer	Two-digit number representing the card's expiration month.
`dynamic_last4`	string	(For tokenized numbers only.) The last four digits of the device account number.
`default_for_currency`	boolean	Whether this card is the default external account for its currency.
`cvc_check`	string	If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
`customer`	string	The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
`currency`	string
`country`	string	Two-letter ISO code representing the country of the card. You could use this attribute t

Resources

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Properties

Request

Body

Properties

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Properties

Request

Path

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Request

Body

Properties

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties

Request

Path

Responses

Body

Properties

Properties

Properties

Properties

Body

Properties