Get multi-use or durable card tokens

See Getting Started before calling the Vault API to get tokens.

To get all tokens associated with a specific merchant:

1. Use GET method to call the rest/v2/tokens endpoint.

The API returns the following response:

{
    "payloadType": "text",
    "tokens": {
        "token": [
            {
                "authorization-code": "ACH789",
                "avs-address": "123 example",
                "avs-zip": "123456",
                "card-type": "VISA",
                "created": "09/19/2016 08:06:78",
                "description": "joint checking",
                "exp-date": "0919",
                "last-four-digits": "5678",
                "merchant-id": "text",
                "merchant-legacy-token-id": "text",
                "software-vendor-name": "text",
                "status": "Active",
                "times-used": "5",
                "token-id": "10009993322221111",
                "token-status": "Open",
                "updated": "09/19/2016 08:06:78",
                "avs-result-code": "X",
                "customer-first-name": "John",
                "customer-key": "customer123",
                "customer-last-name": "Doe",
                "default": false,
                "token-update-status": "UPDATED"
            }
        ]
    }
}

The API response includes the following fields:

Name	Data type	Description
payloadType	String	Indicates the format of the payload content.
tokens	Object	Contains the card tokens associated with the merchant.
tokens.token	Array	Contains token details across multiple fields.
token.authorization-code	String	The code returned by the issuer to approve the transaction.
token.avs-address	String	The address used for Address Verification System (AVS) validation.
token.avs-zip	String	The ZIP code used for Address Verification System (AVS) validation.
token.card-type	String	The type of card used. For examples, VISA, MasterCard.
token.created	String	The date and time when the token were created.
token.description	String	A description of the account or token.
token.exp-date	String	The expiration date of the card in MMYY format.
token.last-four-digits	String	The last four digits of the card number.
token.merchant-id	String	The merchant identifier (MID) associated with the token.
token.merchant-legacy-token-id	String	The legacy token ID used by the merchant.
token.software-vendor-name	String	The name of the software vendor that initiated the token request.
token.status	String	The current status of the token. For example, Active.
token.times-used	String	The number of times the token has been used.
token.token-id	String	The unique identifier for the token.
token.token-status	String	The lifecycle status of the token. For example, Open.
token.updated	String	The date and time when the token were last updated.
token.avs-result-code	String	The result code returned from the Address Verification System (AVS) check.
token.customer-first-name	String	The first name of the customer associated with the token.
token.customer-key	String	The unique identifier for the customer.
token.customer-last-name	String	The last name of the customer associated with the token.
token.default	Boolean	Indicates whether this token is the default for the customer.
token.token-update-status	String	Indicates the result of the token update operation. For example, UPDATED.