# Tokens

Token Controller

## Search Tokens

> Retrieve the list of payment tokens based on filter criteria. Enabling multi-merchant support, the search includes tokens across all related merchants.

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"tags":[{"name":"Tokens","description":"Token Controller"}],"paths":{"/rest/v2/tokens":{"get":{"tags":["Tokens"],"summary":"Search Tokens","description":"Retrieve the list of payment tokens based on filter criteria. Enabling multi-merchant support, the search includes tokens across all related merchants.","operationId":"getTokensUsingGET","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}},{"name":"token-id","in":"query","description":"A unique identifier for the token. Used to search for a specific token.","required":false,"schema":{"type":"string"}},{"name":"merchant-legacy-token-id","in":"query","description":"Merchant-provided identifier. Used to retrieve the token associated with this legacy ID.","required":false,"schema":{"type":"string"}},{"name":"updated-start-date","in":"query","description":"Filters tokens updated after this date/time. Used to define the start of a date range.","required":false,"schema":{"type":"string"}},{"name":"updated-end-date","in":"query","description":"Filters tokens updated before this date/time. Used with updated-start-date to define a date range.","required":false,"schema":{"type":"string"}},{"name":"date-filter","in":"query","description":"Preset date filters. Use custom_range to specify custom start and end dates.","required":false,"schema":{"type":"string","enum":["custom_range","last_24_hours","yesterday","last_week","last_month","last_180_days"]}},{"name":"date-format","in":"query","description":"Specifies the format of the date values. Required if updated-start-date and updated-end-date are provided.","required":false,"schema":{"type":"string","enum":["MM-dd-yyyy hh:mm a","MM-dd-yy HH:mm","MM-dd-yy HH:mm z","yyyy-MM-dd HH:mm","yyyy-MM-dd HH:mm z"]}},{"name":"page","in":"query","description":"Page number for paginated results.","required":false,"schema":{"type":"string"}},{"name":"page-size","in":"query","description":"Number of results per page.","required":false,"schema":{"type":"string"}},{"name":"isDescending","in":"query","description":"Indicates whether results should be listed in descending order.","required":false,"schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponsesPayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenResponsesPayload"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"TokenResponsesPayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of payload returned in the response."},"tokens":{"$ref":"#/components/schemas/TokenResponses"}}},"TokenResponses":{"type":"object","properties":{"token":{"type":"array","items":{"$ref":"#/components/schemas/TokenResponse"}}}},"TokenResponse":{"type":"object","properties":{"authorization-code":{"type":"string","description":"Code used to authorize the original transaction associated with the token."},"avs-address":{"type":"string","description":"Address used for AVS (Address Verification Service) during token creation."},"avs-zip":{"type":"string","description":"ZIP code used for AVS during token creation."},"card-type":{"type":"string","description":"Type of card associated with the token. For example, VISA, MasterCard."},"created":{"type":"string","description":"Timestamp when the token was created."},"description":{"type":"string","description":"Optional description or label for the token. For example, account type."},"exp-date":{"type":"string","description":"Expiration date of the card in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number."},"merchant-id":{"type":"string","description":"Identifier for the merchant who created the token."},"merchant-legacy-token-id":{"type":"string","description":"Merchant-defined identifier for the token."},"software-vendor-name":{"type":"string","description":"Name of the software vendor that processed the token."},"status":{"type":"string","description":"Current status of the token. For example, Active, Inactive."},"times-used":{"type":"string","description":"Number of times the token has been used in transactions."},"token-id":{"type":"string","description":"Xplor Pay-generated unique identifier for the token."},"token-status":{"type":"string","description":"Operational state of the token. For example, Open, Closed.","enum":["Open","Closed","Suspended"]},"updated":{"type":"string","description":"Timestamp of the last update to the token."},"avs-result-code":{"type":"string","description":"Result code from the AVS check. For example, X = match.","enum":["X","Y","A","W","Z","N","U","R","S","G"]},"customer-first-name":{"type":"string","description":"First name of the customer associated with the token."},"customer-key":{"type":"string","description":"Unique identifier for the customer."},"customer-last-name":{"type":"string","description":"Last name of the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is marked as the default for the customer."},"token-update-status":{"type":"string","description":"Status indicating the result of the update operation. For example, UPDATED.","enum":["UPDATED","CLOSED","NOT_PARTICIPATING","CONTACT CARD HOLDER","VALID CARD NO UPDATE"]}}},"ErrorResponse":{"type":"object","description":"Wraps the errorResults array returned for bad requests.","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/ErrorResult"}}},"required":["errorResults"]},"ErrorResult":{"type":"object","description":"Contains detail about a single error returned by a request.","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"string","format":"date-time","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}}}}}}
```

## Create a Token

> Create and returns a reusable payment token for a customer.

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"tags":[{"name":"Tokens","description":"Token Controller"}],"paths":{"/rest/v2/tokens":{"post":{"tags":["Tokens"],"summary":"Create a Token","description":"Create and returns a reusable payment token for a customer.","operationId":"createTokenUsingPOST","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}}},"responses":{"200":{"description":"Successful Token Creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"TokenRequest":{"type":"object","required":["card-type","exp-date"],"properties":{"avs-address":{"type":"string","description":"Street address used for AVS (Address Verification Service)."},"avs-zip":{"type":"string","description":"ZIP code used for AVS verification."},"card":{"type":"string","description":"Full card number to be tokenized."},"card-type":{"type":"string","description":"Type of card. For example, VISA, MasterCard.","enum":["VISA","MASTERCARD","AMERICAN EXPRESS","DISCOVER","DINERS CLUB","JCB"]},"csc":{"type":"string","description":"Card Security Code."},"customer-key":{"type":"string","description":"Unique identifier for the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token should be marked as the default for the customer."},"description":{"type":"string","description":"Optional description or label for the token."},"encrypted-track-data":{"type":"string","description":"Encrypted magnetic stripe data, if applicable."},"exp-date":{"type":"string","description":"Card expiration date in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number used for display/reference."},"require-avs":{"type":"string","description":"Indicates whether AVS validation is required (true or false)."},"require-card-inquiry":{"type":"string","description":"Indicates whether a card inquiry should be performed (true or false)."},"status":{"type":"string","description":"Initial status of the token. For example, Active."},"track-format":{"type":"string","description":"Format of the track data. For example, TRACK2.","enum":["TRACK2","IDTECH","PAX","DEJAVOO","MAGTEK_TRACK_FORMAT"]},"track2-data":{"type":"string","description":"Raw Track 2 data from the card, if applicable."}}},"TokenResponsePayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of payload returned in the response."},"tokenResponse":{"$ref":"#/components/schemas/TokenResponse"}}},"TokenResponse":{"type":"object","properties":{"authorization-code":{"type":"string","description":"Code used to authorize the original transaction associated with the token."},"avs-address":{"type":"string","description":"Address used for AVS (Address Verification Service) during token creation."},"avs-zip":{"type":"string","description":"ZIP code used for AVS during token creation."},"card-type":{"type":"string","description":"Type of card associated with the token. For example, VISA, MasterCard."},"created":{"type":"string","description":"Timestamp when the token was created."},"description":{"type":"string","description":"Optional description or label for the token. For example, account type."},"exp-date":{"type":"string","description":"Expiration date of the card in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number."},"merchant-id":{"type":"string","description":"Identifier for the merchant who created the token."},"merchant-legacy-token-id":{"type":"string","description":"Merchant-defined identifier for the token."},"software-vendor-name":{"type":"string","description":"Name of the software vendor that processed the token."},"status":{"type":"string","description":"Current status of the token. For example, Active, Inactive."},"times-used":{"type":"string","description":"Number of times the token has been used in transactions."},"token-id":{"type":"string","description":"Xplor Pay-generated unique identifier for the token."},"token-status":{"type":"string","description":"Operational state of the token. For example, Open, Closed.","enum":["Open","Closed","Suspended"]},"updated":{"type":"string","description":"Timestamp of the last update to the token."},"avs-result-code":{"type":"string","description":"Result code from the AVS check. For example, X = match.","enum":["X","Y","A","W","Z","N","U","R","S","G"]},"customer-first-name":{"type":"string","description":"First name of the customer associated with the token."},"customer-key":{"type":"string","description":"Unique identifier for the customer."},"customer-last-name":{"type":"string","description":"Last name of the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is marked as the default for the customer."},"token-update-status":{"type":"string","description":"Status indicating the result of the update operation. For example, UPDATED.","enum":["UPDATED","CLOSED","NOT_PARTICIPATING","CONTACT CARD HOLDER","VALID CARD NO UPDATE"]}}},"ErrorResponse":{"type":"object","description":"Wraps the errorResults array returned for bad requests.","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/ErrorResult"}}},"required":["errorResults"]},"ErrorResult":{"type":"object","description":"Contains detail about a single error returned by a request.","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"string","format":"date-time","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}}}}}}
```

## Get a Token

> Retrieve the details of a specific payment token as per token ID.

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"tags":[{"name":"Tokens","description":"Token Controller"}],"paths":{"/rest/v2/tokens/{token-id}":{"get":{"tags":["Tokens"],"summary":"Get a Token","description":"Retrieve the details of a specific payment token as per token ID.","operationId":"getTokenUsingGET","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}},{"name":"token-id","in":"path","description":"A unique identifier for the token. Used to search for a specific token.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"components":{"schemas":{"TokenResponsePayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of payload returned in the response."},"tokenResponse":{"$ref":"#/components/schemas/TokenResponse"}}},"TokenResponse":{"type":"object","properties":{"authorization-code":{"type":"string","description":"Code used to authorize the original transaction associated with the token."},"avs-address":{"type":"string","description":"Address used for AVS (Address Verification Service) during token creation."},"avs-zip":{"type":"string","description":"ZIP code used for AVS during token creation."},"card-type":{"type":"string","description":"Type of card associated with the token. For example, VISA, MasterCard."},"created":{"type":"string","description":"Timestamp when the token was created."},"description":{"type":"string","description":"Optional description or label for the token. For example, account type."},"exp-date":{"type":"string","description":"Expiration date of the card in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number."},"merchant-id":{"type":"string","description":"Identifier for the merchant who created the token."},"merchant-legacy-token-id":{"type":"string","description":"Merchant-defined identifier for the token."},"software-vendor-name":{"type":"string","description":"Name of the software vendor that processed the token."},"status":{"type":"string","description":"Current status of the token. For example, Active, Inactive."},"times-used":{"type":"string","description":"Number of times the token has been used in transactions."},"token-id":{"type":"string","description":"Xplor Pay-generated unique identifier for the token."},"token-status":{"type":"string","description":"Operational state of the token. For example, Open, Closed.","enum":["Open","Closed","Suspended"]},"updated":{"type":"string","description":"Timestamp of the last update to the token."},"avs-result-code":{"type":"string","description":"Result code from the AVS check. For example, X = match.","enum":["X","Y","A","W","Z","N","U","R","S","G"]},"customer-first-name":{"type":"string","description":"First name of the customer associated with the token."},"customer-key":{"type":"string","description":"Unique identifier for the customer."},"customer-last-name":{"type":"string","description":"Last name of the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is marked as the default for the customer."},"token-update-status":{"type":"string","description":"Status indicating the result of the update operation. For example, UPDATED.","enum":["UPDATED","CLOSED","NOT_PARTICIPATING","CONTACT CARD HOLDER","VALID CARD NO UPDATE"]}}},"ErrorResponse":{"type":"object","description":"Wraps the errorResults array returned for bad requests.","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/ErrorResult"}}},"required":["errorResults"]},"ErrorResult":{"type":"object","description":"Contains detail about a single error returned by a request.","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"string","format":"date-time","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}}}}}}
```

## Update a Token

> Update the details of an existing payment token for a customer using specific token ID.

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"tags":[{"name":"Tokens","description":"Token Controller"}],"paths":{"/rest/v2/tokens/{token-id}":{"put":{"tags":["Tokens"],"summary":"Update a Token","description":"Update the details of an existing payment token for a customer using specific token ID.","operationId":"createTokenUsingPUT","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}},{"name":"tokenId","in":"path","description":"Unique identifier for the token to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenRequest"}}}},"responses":{"200":{"description":"Successful Token Update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"UpdateTokenRequest":{"type":"object","properties":{"avs-address":{"type":"string","description":"Updated street address used for AVS (Address Verification Service)."},"avs-zip":{"type":"string","description":"Updated ZIP code used for AVS verification."},"default":{"type":"boolean","description":"Indicates whether this token should be marked as the default for the customer."},"description":{"type":"string","description":"Updated description or label for the token. For example, account type or purpose."}}},"TokenResponsePayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of payload returned in the response."},"tokenResponse":{"$ref":"#/components/schemas/TokenResponse"}}},"TokenResponse":{"type":"object","properties":{"authorization-code":{"type":"string","description":"Code used to authorize the original transaction associated with the token."},"avs-address":{"type":"string","description":"Address used for AVS (Address Verification Service) during token creation."},"avs-zip":{"type":"string","description":"ZIP code used for AVS during token creation."},"card-type":{"type":"string","description":"Type of card associated with the token. For example, VISA, MasterCard."},"created":{"type":"string","description":"Timestamp when the token was created."},"description":{"type":"string","description":"Optional description or label for the token. For example, account type."},"exp-date":{"type":"string","description":"Expiration date of the card in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number."},"merchant-id":{"type":"string","description":"Identifier for the merchant who created the token."},"merchant-legacy-token-id":{"type":"string","description":"Merchant-defined identifier for the token."},"software-vendor-name":{"type":"string","description":"Name of the software vendor that processed the token."},"status":{"type":"string","description":"Current status of the token. For example, Active, Inactive."},"times-used":{"type":"string","description":"Number of times the token has been used in transactions."},"token-id":{"type":"string","description":"Xplor Pay-generated unique identifier for the token."},"token-status":{"type":"string","description":"Operational state of the token. For example, Open, Closed.","enum":["Open","Closed","Suspended"]},"updated":{"type":"string","description":"Timestamp of the last update to the token."},"avs-result-code":{"type":"string","description":"Result code from the AVS check. For example, X = match.","enum":["X","Y","A","W","Z","N","U","R","S","G"]},"customer-first-name":{"type":"string","description":"First name of the customer associated with the token."},"customer-key":{"type":"string","description":"Unique identifier for the customer."},"customer-last-name":{"type":"string","description":"Last name of the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is marked as the default for the customer."},"token-update-status":{"type":"string","description":"Status indicating the result of the update operation. For example, UPDATED.","enum":["UPDATED","CLOSED","NOT_PARTICIPATING","CONTACT CARD HOLDER","VALID CARD NO UPDATE"]}}},"ErrorResponse":{"type":"object","description":"Wraps the errorResults array returned for bad requests.","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/ErrorResult"}}},"required":["errorResults"]},"ErrorResult":{"type":"object","description":"Contains detail about a single error returned by a request.","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"string","format":"date-time","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}}}}}}
```

## Delete a Token

> Delete the existing payment token for a customer using specific token ID.

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"tags":[{"name":"Tokens","description":"Token Controller"}],"paths":{"/rest/v2/tokens/{token-id}":{"delete":{"tags":["Tokens"],"summary":"Delete a Token","description":"Delete the existing payment token for a customer using specific token ID.","operationId":"deleteTokenUsingDELETE","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}},{"name":"token-id","in":"path","description":"A unique identifier for the token. Used to delete a specific token.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TokenResponsePayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"TokenResponsePayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of payload returned in the response."},"tokenResponse":{"$ref":"#/components/schemas/TokenResponse"}}},"TokenResponse":{"type":"object","properties":{"authorization-code":{"type":"string","description":"Code used to authorize the original transaction associated with the token."},"avs-address":{"type":"string","description":"Address used for AVS (Address Verification Service) during token creation."},"avs-zip":{"type":"string","description":"ZIP code used for AVS during token creation."},"card-type":{"type":"string","description":"Type of card associated with the token. For example, VISA, MasterCard."},"created":{"type":"string","description":"Timestamp when the token was created."},"description":{"type":"string","description":"Optional description or label for the token. For example, account type."},"exp-date":{"type":"string","description":"Expiration date of the card in MMYY format."},"last-four-digits":{"type":"string","description":"Last four digits of the card number."},"merchant-id":{"type":"string","description":"Identifier for the merchant who created the token."},"merchant-legacy-token-id":{"type":"string","description":"Merchant-defined identifier for the token."},"software-vendor-name":{"type":"string","description":"Name of the software vendor that processed the token."},"status":{"type":"string","description":"Current status of the token. For example, Active, Inactive."},"times-used":{"type":"string","description":"Number of times the token has been used in transactions."},"token-id":{"type":"string","description":"Xplor Pay-generated unique identifier for the token."},"token-status":{"type":"string","description":"Operational state of the token. For example, Open, Closed.","enum":["Open","Closed","Suspended"]},"updated":{"type":"string","description":"Timestamp of the last update to the token."},"avs-result-code":{"type":"string","description":"Result code from the AVS check. For example, X = match.","enum":["X","Y","A","W","Z","N","U","R","S","G"]},"customer-first-name":{"type":"string","description":"First name of the customer associated with the token."},"customer-key":{"type":"string","description":"Unique identifier for the customer."},"customer-last-name":{"type":"string","description":"Last name of the customer associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is marked as the default for the customer."},"token-update-status":{"type":"string","description":"Status indicating the result of the update operation. For example, UPDATED.","enum":["UPDATED","CLOSED","NOT_PARTICIPATING","CONTACT CARD HOLDER","VALID CARD NO UPDATE"]}}},"ErrorResponse":{"type":"object","description":"Wraps the errorResults array returned for bad requests.","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/ErrorResult"}}},"required":["errorResults"]},"ErrorResult":{"type":"object","description":"Contains detail about a single error returned by a request.","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"string","format":"date-time","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}}}}}}
```