# Models

## The TokenRequest object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"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."}}}}}}
```

## The ErrorResult object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"components":{"schemas":{"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)."}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"components":{"schemas":{"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)."}}}}}}
```

## The TokenResponse object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"components":{"schemas":{"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"]}}}}}}
```

## The TokenResponsePayload object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"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"]}}}}}}
```

## The TokenResponses object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"components":{"schemas":{"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"]}}}}}}
```

## The TokenResponsesPayload object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"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"]}}}}}}
```

## The UpdateTokenRequest object

```json
{"openapi":"3.0.0","info":{"title":"Vault API","version":"2.0"},"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."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/vault/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.