API ReferencePayment Methods API

Delete a saved payment method

Delete a saved payment method.

Path parameters

paymentMethodTokenstringRequired
Saved payment method token to delete.

Headers

X-API-KEYstringRequired
X-API-VERSIONstringRequired

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

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