Skip to main content
GET

Query & Retrieve Guide

Search for tokens and retrieve their metadata
Returns non-sensitive metadata for a single token, including the card type, masked card number, expiration date, CVV status, and 3D Secure data. Use this endpoint to inspect token details without exposing the full card number or entering PCI DSS scope.

Error Responses

This endpoint is rate limited.

Parameters

Headers

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

Path Parameters

cardtoken
string
required
The token ID as returned by one of the tokenization methods. For example, 2821a46d80e14d1b96a7f18f1b81926d.

Response

200
CreatorReference
string
The reference value set when the card was tokenized.
CreateDate
string
The date and time the token was created (ISO 8601).
CardType
string
The card brand (e.g. Visa, Mastercard, Amex). See supported card types.
LeadingDigits
string
The first 6 digits (BIN) of the card number.
LastDigits
string
The last 4 digits of the card number.
ExpirationYear
integer
The card expiration year.
ExpirationMonth
integer
The card expiration month.
OwnerID
string
The cardholder ID, if provided at tokenization time.
OwnerName
string
The name on the card, if provided at tokenization time.
UserID
string
The PCI Booking user ID that owns this token.
IssueNumber
string
The card issue number (used by some card schemes).
URI
string
The full token URI for use in API calls.
CvvExists
boolean
Whether CVV data is currently stored on this token.
EndRetentionDate
string
The date after which the CVV will be automatically deleted (ISO 8601). Reflects the CVV retention policy.
AssociatedMerchants
string[]
List of PCI Booking customer (booker) user IDs associated with this token.
AssociatedProperties
string[]
List of property user IDs associated with this token.
ThreeDSecureInfo
object
3D Secure authentication data, if stored on this token. See 3D Secure Authentication for field details.
NetworkTokenScheme
string
The card network scheme if this is a network token (e.g. Visa, Mastercard). null for regular cards.
NetworkTokenId
string
The network token identifier assigned by the card scheme. null for regular cards.
TokenLocation
string
The geographic storage location of the token data. null for default (in-table) storage.
VirtualInfo
object
Virtual card metadata, if this token was created from a virtual card. Contains IsMultiUse, Currency, MaxAmount, CardRules, and validity date fields. null for regular cards.