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

Request

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

Response

Successful Response
createdAtdatetimeOptional

Creation date & time of the object (UTC)

deletedAtdatetimeOptional

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

deletedbooleanOptional
Whether or not this object has been revoked.
tokenstringOptional
The vaulted payment method token.
tokenTypestringOptional
  • MULTI_USE a vaulted token that can be re-used with subsequent payments
analyticsIdstringOptional
Unique analytics identifier corresponding to a payment method
paymentMethodTypeenumOptional
Payment method type associated with a token.
paymentMethodDataobjectOptional
Payment method data
customerIdstringOptional
The ID representing the customer
descriptionstringOptional
A friendly description given by the user
defaultbooleanOptionalDefaults to false
Whether or not this payment method is the default

Errors