Payers APIStored 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.

analyticsIdstringOptional

Unique analytics identifier corresponding to a payment method.

createdAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Creation date & time of the object (UTC).

customerIdstringOptional

The ID representing the customer.

defaultbooleanOptionalDefaults to false

Whether or not this payment method is the default.

deletedbooleanOptionalDefaults to false

Whether or not this object has been revoked.

deletedAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

descriptionstringOptional

A friendly description given by the user.

isVerifiedbooleanOptionalDefaults to false

Whether or not this payment method was verified.

paymentMethodDataobjectOptional
paymentMethodTypestringOptional

Payment method type associated with a token.

tokenstringOptional

The vaulted payment method token.

tokenTypestringOptional

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

Errors