Skip to main content
GET
Query Tokens

Query & Retrieve Guide

Search for tokens and retrieve their metadata
Use this endpoint to search for stored card tokens by the reference value you assigned during tokenization. It returns metadata (card type, last digits, expiration, associations) for up to 100 matching tokens per request, with pagination support for larger result sets.

Parameter Constraints

This endpoint is rate limited.

Error Responses

Parameters

Headers

string
required
Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Query String

string
The reference value provided during tokenization to locate this token. Exact match only.
integer
default:"0"
Chronological counter of tokens from which to start retrieving.
integer
default:"100"
The number of tokens to return in the response.
string
The property ID of the hotel the tokens were associated with. You would have used this method to set up the association first.

Request Example

Query all tokens created with the reference booking-12345, returning the first 10 results:
To filter by property, add the property parameter:

Response

200 - An array of token metadata objects. If no cards match the query, the response is a 200 with an empty array - not an error. Each item contains the fields below. For the single-token equivalent (which also returns CreatorReference and VirtualInfo), see Retrieve Token Metadata.
string
The date and time the token was created (ISO 8601).
string
The card brand (e.g. Visa, Mastercard, Amex). See supported card types.
string
The first 6 digits (BIN) of the card number.
string
The last 4 digits of the card number.
integer
The card expiration year.
integer
The card expiration month.
string
The cardholder ID, if provided at tokenization time.
string
The name on the card, if provided at tokenization time.
string
The PCI Booking user ID that owns this token.
string
The card issue number (used by some card schemes).
string
The full token URI for use in API calls.
boolean
Whether CVV data is currently stored on this token.
string
The date after which the CVV will be automatically deleted (ISO 8601). Reflects the CVV retention policy.
string[]
List of PCI Booking customer (booker) user IDs associated with this token.
string[]
List of property user IDs associated with this token.
object
3D Secure authentication data, if stored on this token. See 3D Secure Authentication for field details.
string
The card network scheme if this is a network token (e.g. Visa, Mastercard). null for regular cards.
string
The network token identifier assigned by the card scheme. null for regular cards.
string
The geographic storage location of the token data. null for default (in-table) storage.