Skip to main content
POST
Delete Card

Notes

  • card_id is the same identifier as the enrollmentId returned by the SDK’s collectPAN and the card_id in List Cards.
  • Deletion also retires the card’s network token (the tokenized stand-in for the card at the card network) where one exists — network_token_deleted in the response tells you whether that happened.
  • If the deleted card was the customer’s default, was_default is true; the customer picks a new default on their next payment.

Error responses

Authorizations

Authorization
string
header
required

Your secret key: sk_test_* (sandbox) or sk_live_* (production).

Body

application/json
customer_id
string
required

The customer whose card to delete (the user_id used at session creation)

card_id
string
required

The card to delete (same as enrollmentId from the SDK's collectPAN())

reason
enum<string>
default:OTHER

Why the card is being deleted

Available options:
CUSTOMER_CONFIRMED,
LOST,
STOLEN,
SUSPECTED_FRAUD,
CLOSED_ACCOUNT,
OTHER

Response

Card deleted

success
boolean
card_id
string
was_default
boolean

Whether the deleted card was the customer's default

network_token_deleted
boolean

Whether a card-network token was retired as part of the deletion