Collect Updated Payment Details

Retrieve token update statuses and collect a replacement payment method when required.

When Account Updater is enabled, retrieve token details before authorization. Inspect token-update-status before you charge the stored card.

A CLOSED status means you must not authorize the token. Collect a new payment method from the cardholder.

Retrieve token details

Use the Tokens API to retrieve a token or search by Account Updater status.

Request property	Value
Method	GET
Endpoint	https://gateway.clearent.net/rest/v2/tokens
Authentication	api-key header with your secret API key
Content type	application/json
Closed-token filter	?token-update-status=CLOSED
Single-token endpoint	https://gateway.clearent.net/rest/v2/tokens/{token-id}

Search for closed tokens

GET /rest/v2/tokens?token-update-status=CLOSED HTTP/1.1
Host: gateway.clearent.net
api-key: <secret-api-key>
Content-Type: application/json

Use the returned token-id to locate the customer in your system. Then ask the customer for a replacement payment method.

Replace the payment method

1. Stop future billing against the unusable token.
2. Contact the customer using your approved communication channel.
3. Collect and tokenize the new payment method.
4. Associate the replacement token with future payments.

Do not store raw card data in your system.

Related topics

• See Tokens to retrieve and manage payment tokens.
• See Tokenization before collecting a replacement payment method.