# Vault API

{% hint style="info" %}
See [Authentication | Xplor Pay Documentation](https://docs.xplorpay.com/api-references/authentication) before calling the [Vault API](https://docs.xplorpay.com/api-references/payments/cards/vault).
{% endhint %}

To check card updates using the [Get a token](https://docs.xplorpay.com/api-references/payments/cards/vault/tokens#get-rest-v2-tokens-token-id) endpoint:

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

<table><thead><tr><th width="122" valign="top">Name</th><th width="120.66668701171875" valign="top">Data type</th><th width="116.00006103515625" valign="top">Required?</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>token-id</code></td><td valign="top">String</td><td valign="top">Required</td><td valign="top"><p>The unique token ID returned in the response from the <a href="https://docs.xplorpay.com/api-references/payments/cards/vault/tokens#post-rest-v2-tokens">Create a Token</a> endpoint.</p><p>For example, <code>0009993322221111</code>.</p></td></tr></tbody></table>

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

The API returns the response including the following field.

<table><thead><tr><th width="182.3333740234375" valign="top">Name</th><th width="119" valign="top">Data type</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>token-update-status</code></td><td valign="top">String</td><td valign="top"><p>Indicates the status of the token update operation.</p><p>Available statuses are:</p><ul><li><p><strong>UPDATED</strong>: The card has been updated with one or more of the following changes.</p><ul><li>Card number change: Updated to the new card number.</li><li>Expiration date change: Updated to the new expiry date.</li><li>Card number &#x26; expiration date: Updated to the new card number and the new expiry date.</li><li>Card brand migration: Migrated to different card brand.</li></ul></li><li><strong>CLOSED</strong>: Unable to update the card.</li><li><strong>NOT_PARTICIPATING</strong>: The card does not participate in Account Updater services. Contact the cardholder if the card is declined.</li><li><strong>CONTACT CARD HOLDER</strong>: Contact the cardholder directly to request updated card information.</li><li><strong>VALID CARD</strong>: The card number is valid. No update is needed, and no fees are charged.</li><li><strong>NO UPDATE</strong>: No updated card information is available from the Account Updater service.</li></ul></td></tr></tbody></table>

{% hint style="info" %}
See [Get a token endpoint](https://docs.xplorpay.com/api-references/payments/cards/vault/tokens#get-rest-v2-tokens-token-id) response for more information.
{% endhint %}
