Payers API [BETA]Stored Payment Methods

Delete Stored Payment Method

Deletes a stored payment method associated with a payer. This operation is useful for removing outdated or unused payment methods, ensuring that only valid and current payment options are available for transactions.

Path parameters

payerIdstringRequired
The unique identifier for the payer.
paymentMethodTokenstringRequired
The token representing the payment method to delete.

Response

Payment method deleted successfully.
analyticsIdstring or null
Unique analytics identifier corresponding to a payment method.
createdAtdatetime or nullDefaults to 1970-01-01T00:00:00.000Z

Creation date & time of the object (UTC).

customerIdstring or null
The ID representing the customer.
defaultboolean or nullDefaults to false
Whether or not this payment method is the default.
deletedboolean or nullDefaults to false
Whether or not this object has been revoked.
deletedAtdatetime or nullDefaults to 1970-01-01T00:00:00.000Z

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

descriptionstring or null
A friendly description given by the user.
isVerifiedboolean or nullDefaults to false
Whether or not this payment method was verified.
paymentMethodDataobject or null
paymentMethodTypestring or null
Payment method type associated with a token.
tokenstring or null
The vaulted payment method token.
tokenTypestring or null

Type of the token (e.g., MULTI_USE).

Errors