Create a bank account token

Changed on

Creates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

post/v1/tokens

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/tokens
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

customerstring

Create a token for the customer, which is owned by the application's account. You can only use this with an OAuth access token or Stripe-Account header. Learn more about cloning saved payment methods.

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

client_ipstring nullable

IP address of the client that generates the token.

createdinteger required

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'token' required

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

typestring required

Type of the token: account, bank_account, card, or pii.

usedboolean required

Determines if you have already used this token (you can only use tokens once).

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the ///////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ///////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.