Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 3.0!

Retrieve metadata for a token

PCI Booking offers its customers the ability to retrieve metadata information relating to a single token or multiple tokens - while still maintaining PCI compliance by not providing the full card details.

  • In order to retrieve the metadata for a list of tokens (by reference), please use the Query Paycard method.
  • In order to retrieve the metadata of a single token (by token ID), please use the Retrieve a Paycard Metadata method.

The metadata for a token - whether queried as part of a list or individually, will contain the following information:

Parameter Name

Parameter Type

Description

VirtualInfo

String

Information provided if this token represents a virtual card.
Please note, this value will only be returned when retrieving the metadata for an individual token.

CreatorReference

String

The reference value which was provided during the tokenization process to locate this token.
Please note, this value will only be returned when retrieving the metadata for an individual token.

CardType

String

The type of card that was tokenized. If the card type was not specified during tokenization, this parameter will show unspecified.

LastDigits

String

The last 4 digits of the card number.

LeadingDigits

String

The first 6 digits of the card number.

ExpirationYear

Integer

The year of the card's expiration date.

ExpirationMonth

Integer

The month of the card's expiration date.

OwnerID

String

The value provided in the owner ID field during tokenization.

UserID

String

The username of the user that tokenized this card.

IssueNumber

String

The value provided in the issue number field during tokenization.

OwnerName

String

The name on the card as provided during tokenization.

URI

String

The card URI in PCI Booking. You will need this value in order to perform any sort of action on this card.

EndRetentionDate

Date Time

The date that the CVV retention period ends.

CvvExists

Boolean

A boolean value indication if the CVV for this token still exists in PCI Booking.

AssociatedMerchants

Array of String

An array of the user IDs of the merchants associated with this token. (read more at Associate Paycard with a PCI Booking Customer).

AssociatedProperties

Array of String

An array of the property IDs of the properties associated with this token. (read more at Associate Paycard with a Property).