Query Tokens

const params = new URLSearchParams({
  ref: 'booking-12345',
  from: '0',
  to: '10'
});

const response = await fetch(
  `https://service.pcibooking.net/api/payments/paycard/meta?${params}`,
  {
    headers: {
      'Authorization': 'APIKEY your-api-key'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://service.pcibooking.net/api/payments/paycard/meta',
    headers={'Authorization': 'APIKEY your-api-key'},
    params={
        'ref': 'booking-12345',
        'from': 0,
        'to': 10
    }
)

print(response.json())

[
    {
        "CreateDate": "2020-05-19T16:51:00",
        "CardType": "Visa",
        "LastDigits": "5005",
        "LeadingDigits": "491891",
        "ExpirationYear": 2020,
        "ExpirationMonth": 7,
        "OwnerID": "",
        "OwnerName": "Juan Dela Cruz",
        "UserID": "myUser",
        "IssueNumber": "2",
        "URI": "https://service.pcibooking.net/api/payments/paycard/eb454e0462d548ddbc6e6c2193b749a9",
        "EndRetentionDate": "2017-07-08T00:00:00",
        "CvvExists": true,
        "AssociatedMerchants": ["userID1", "userID2"],
        "AssociatedProperties": ["hotel1", "hotel2"],
        "ThreeDSecureInfo": {
            "Token": "42c775efa8b04b1d8bf14ef49a9e45e5",
            "ThreeDSSessionID": "uOrDbh0dEimUDmB3Vvn2f5CAM9B1bMQX",
            "Indication": "Authenticated",
            "AuthenticationValue": "AJkBAoEREQAAAAB4hABwcAAAAAA=",
            "Eci": "05",
            "XID": "861433f4-abff-4c40-b2fd-fea208856a33",
            "AcsTransactionId": "e7a46959-9630-413e-ab56-4e399b96244a",
            "Version": "2.1.0",
            "MerchantName": "PCI Booking * Hotelreservation"
        },
        "NetworkTokenScheme": null,
        "NetworkTokenId": null,
        "TokenLocation": null
    }
]

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

GET

api

payments

paycard

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

Parameter	Type	Required	Constraints
to	integer	No	Maximum number of results to return. Defaults to `100`
from	integer	No	Pagination offset (chronological counter). Defaults to `0`
ref	string	No	Filter by creator reference value (exact match)
property	string	No	Filter by associated property ID

This endpoint is rate limited. Standard authentication errors apply (code -1003, HTTP 401).

Parameters

Headers

Authorization

string

required

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

Query String

ref

string

required

The reference value provided during tokenization to locate this token. Exact match only.

from

integer

default:"0"

Chronological counter of tokens from which to start retrieving.

integer

default:"100"

The number of tokens to return in the response.

property

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:

curl
Node.js
Python

curl -G "https://service.pcibooking.net/api/payments/paycard/meta" \
  -H "Authorization: APIKEY your-api-key" \
  --data-urlencode "ref=booking-12345" \
  --data-urlencode "from=0" \
  --data-urlencode "to=10"

const params = new URLSearchParams({
  ref: "booking-12345",
  from: "0",
  to: "10"
});

const response = await fetch(
  `https://service.pcibooking.net/api/payments/paycard/meta?${params}`,
  {
    headers: {
      "Authorization": "APIKEY your-api-key"
    }
  }
);

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://service.pcibooking.net/api/payments/paycard/meta",
    headers={"Authorization": "APIKEY your-api-key"},
    params={
        "ref": "booking-12345",
        "from": 0,
        "to": 10
    }
)

print(response.json())

To filter by property, add the property parameter:

curl
Node.js
Python

curl -G "https://service.pcibooking.net/api/payments/paycard/meta" \
  -H "Authorization: APIKEY your-api-key" \
  --data-urlencode "ref=booking-12345" \
  --data-urlencode "property=hotel-sunrise"

const params = new URLSearchParams({
  ref: "booking-12345",
  property: "hotel-sunrise"
});

const response = await fetch(
  `https://service.pcibooking.net/api/payments/paycard/meta?${params}`,
  {
    headers: {
      "Authorization": "APIKEY your-api-key"
    }
  }
);

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://service.pcibooking.net/api/payments/paycard/meta",
    headers={"Authorization": "APIKEY your-api-key"},
    params={
        "ref": "booking-12345",
        "property": "hotel-sunrise"
    }
)

print(response.json())

const params = new URLSearchParams({
  ref: 'booking-12345',
  from: '0',
  to: '10'
});

const response = await fetch(
  `https://service.pcibooking.net/api/payments/paycard/meta?${params}`,
  {
    headers: {
      'Authorization': 'APIKEY your-api-key'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://service.pcibooking.net/api/payments/paycard/meta',
    headers={'Authorization': 'APIKEY your-api-key'},
    params={
        'ref': 'booking-12345',
        'from': 0,
        'to': 10
    }
)

print(response.json())

Response

200 - An array of token metadata objects. Each item contains the fields below. For the single-token equivalent (which also returns CreatorReference and VirtualInfo), see Retrieve Token Metadata.

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.

[
    {
        "CreateDate": "2020-05-19T16:51:00",
        "CardType": "Visa",
        "LastDigits": "5005",
        "LeadingDigits": "491891",
        "ExpirationYear": 2020,
        "ExpirationMonth": 7,
        "OwnerID": "",
        "OwnerName": "Juan Dela Cruz",
        "UserID": "myUser",
        "IssueNumber": "2",
        "URI": "https://service.pcibooking.net/api/payments/paycard/eb454e0462d548ddbc6e6c2193b749a9",
        "EndRetentionDate": "2017-07-08T00:00:00",
        "CvvExists": true,
        "AssociatedMerchants": ["userID1", "userID2"],
        "AssociatedProperties": ["hotel1", "hotel2"],
        "ThreeDSecureInfo": {
            "Token": "42c775efa8b04b1d8bf14ef49a9e45e5",
            "ThreeDSSessionID": "uOrDbh0dEimUDmB3Vvn2f5CAM9B1bMQX",
            "Indication": "Authenticated",
            "AuthenticationValue": "AJkBAoEREQAAAAB4hABwcAAAAAA=",
            "Eci": "05",
            "XID": "861433f4-abff-4c40-b2fd-fea208856a33",
            "AcsTransactionId": "e7a46959-9630-413e-ab56-4e399b96244a",
            "Version": "2.1.0",
            "MerchantName": "PCI Booking * Hotelreservation"
        },
        "NetworkTokenScheme": null,
        "NetworkTokenId": null,
        "TokenLocation": null
    }
]

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

Manage Tokens API Reference Retrieve Metadata

Start Here

Authentication & General

Capture Cards

Manage Tokens

Use Tokens

Additional Functions

Payments Library

Query & Retrieve Guide

Parameter Constraints

Parameters

Headers

Query String

Request Example

Response

Query & Retrieve Guide

​Parameter Constraints

​Parameters

​Headers

​Query String

​Request Example

​Response

Parameter Constraints

Parameters

Headers

Query String

Request Example

Response