API ReferencePayment Methods API

Save a payment method token

Save a SINGLE_USE payment method token so it can be used again later.

If you try to vault an already vaulted token, you will get the existing vaulted token back.

Path parameters

paymentMethodTokenstringRequired
Payment method token to store.

Headers

X-API-KEYstringRequired
X-API-VERSIONstringRequired

Specifies the version of the API to use. This must be set to 2.4.

Request

This endpoint expects an object.
customerIdstringRequired>=1 character
The ID representing the customer

Response

Successful Response
createdAtdatetime or null

Creation date & time of the object (UTC)

deletedAtdatetime or null

Date & time when this object was revoked. (UTC)

deletedboolean or null
Whether or not this object has been revoked.
tokenstring or null
The vaulted payment method token.
tokenTypestring or null
  • MULTI_USE a vaulted token that can be re-used with subsequent payments
analyticsIdstring or null
Unique analytics identifier corresponding to a payment method
paymentMethodTypeenum or null
Payment method type associated with a token.
paymentMethodDataobject or null
Payment method data
customerIdstring or null
The ID representing the customer
descriptionstring or null
A friendly description given by the user
defaultboolean or nullDefaults to false
Whether or not this payment method is the default

Errors