Vault API

See Authentication | Xplor Pay Documentation before calling the Vault API.

To check card updates using the Get a token endpoint:

1. Add the following path parameter into the request URL of the rest/v2/tokens/{token-id} endpoint.

Name	Data type	Required?	Description
token-id	String	Required	The unique token ID returned in the response from the Create a Token endpoint. For example, 0009993322221111.

1. Use GET method to call the rest/v2/tokens/{token-id} endpoint.

The API returns the response including the following field.

Name	Data type	Description
token-update-status	String	Indicates the status of the token update operation. Available statuses are: UPDATED: The card has been updated with one or more of the following changes. Card number change: Updated to the new card number. Expiration date change: Updated to the new expiry date. Card number & expiration date: Updated to the new card number and the new expiry date. Card brand migration: Migrated to different card brand. CLOSED: Unable to update the card. NOT_PARTICIPATING: The card does not participate in Account Updater services. Contact the cardholder if the card is declined. CONTACT CARD HOLDER: Contact the cardholder directly to request updated card information. VALID CARD: The card number is valid. No update is needed, and no fees are charged. NO UPDATE: No updated card information is available from the Account Updater service.

See Get a token endpoint response for more information.