Payment Instrument Tokenization
Retrieve information about single-use tokens
Get information relating to a single-use token
get/payment-instruments/single-use
Query parameters
tokensstring[] required
Comma-separated set of single-use tokens.
showPanLeadingCharsboolean
The leading six digits of a cards PAN are the issuer identification number (IIN) sometimes referred to as the "bank identification number (BIN)" which may be required for some use cases.
By default this information is not provided, but you can opt-in by setting this flag to true if you specifically need it.
E.g. 1234 56## #### 7890 instead of the default #### #### #### 7890
Response
Map of obfuscated card details, keyed by their single-use token.
Example response
{
"id": "example-response-trace-id",
"results": {
"3d967f3e-8710-4c2b-9828-28b9531617f1": {
"cardType": "VISA",
"nameOnCard": "John F Doe",
"pan": "#### #### #### 1111",
"expiryDate": "06-30",
"startDate": "01-20",
"issueNumber": 0,
"customerId": "example-customer-id",
"tokenType": "CARD",
"metadata": {
"metadataType": "cardMetaData",
"cardBrand": "VISA",
"issuer": "ACMEBANK",
"type": "DEBIT",
"category": "CLASSIC",
"countryIsoA2": "GB",
"commercial": true,
"bin": "45678765"
},
"fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6",
"fingerprintExtended": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60630"
},
"example-token-2": {
"cardType": "MASTERCARD",
"nameOnCard": "Jane Doe",
"pan": "#### #### #### 1234",
"expiryDate": "07-31",
"startDate": "09-21",
"issueNumber": 2,
"customerId": "example-customer-id",
"tokenType": "CARD",
"fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6",
"fingerprintExtended": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60731"
},
"4c5f1e1d-a8d4-403c-8199-e9705da98735": {
"cardType": "MASTERCARD",
"nameOnCard": "John F Doe",
"pan": "#### #### #### 4321",
"expiryDate": "02-29",
"startDate": "10-20",
"customerId": "example-customer-id",
"tokenType": "CARD",
"metadata": {
"metadataType": "cardMetaData",
"cardBrand": "MASTERCARD",
"type": "DEBIT",
"countryIsoA2": "GB",
"bin": "45678765"
},
"fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6",
"fingerprintExtended": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c60229"
}
}
}