Create an account token
Creates a single-use token that wraps a user’s legal entity information. Use this when creating or updating a Connect account. Learn more about account tokens.
In live mode, you can only create account tokens with your application’s publishable key. In test mode, you can only create account tokens with your secret key or publishable key.
Parameters
- accountobjectRequired
Information for the account this token represents.
Returns
Returns the created account token if it’s successful. Otherwise, this call raises an error.
Create a bank account token
Creates a single-use token that represents a bank account’s details. You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.
Parameters
- bank_
accountobject The bank account this token will represent.
More parameters
- customerstringConnect only
Returns
Returns the created bank account token if it’s successful. Otherwise, this call raises an error.
Create a card token
Creates a single-use token that represents a credit card’s details. You can use this token in place of a credit card dictionary with any API method. You can only use these tokens once by creating a new Charge object or by attaching them to a Customer object.
In most cases, you can use our recommended payments integrations instead of using the API.
Parameters
- cardobject | string
The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user’s credit card details, with the options described below.
Returns
Returns the created card token if it’s successful. Otherwise, this call raises an error.
Create a CVC update token
Creates a single-use token that represents an updated CVC value that you can use for CVC re-collection. Use this token when you confirm a card payment or use a saved card on a PaymentIntent with confirmation_method: manual.
For most cases, use our JavaScript library instead of using the API. For a PaymentIntent with confirmation_method: automatic, use our recommended payments integration without tokenizing the CVC value.
Parameters
- cvc_
updateobjectRequired The updated CVC value this token represents.
Returns
Returns the created CVC update token if it’s successful. Otherwise, this call raises an error.
Create a person token
Creates a single-use token that represents the details for a person. Use this when you create or update persons associated with a Connect account. Learn more about account tokens.
You can only create person tokens with your application’s publishable key and in live mode. You can use your application’s secret key to create person tokens only in test mode.
Parameters
- personobjectRequired
Information for the person this token represents.
Returns
Returns the created person token if it’s successful. Otherwise, this call raises an error.