v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB

Card Tokenization

Get details for a card payment token.

get/api/v1/cards/{publicToken}/payment-tokens/{tokenId}

Path parameters

tokenIdinteger required

The ID of the payment token to retrieve.

publicTokenstring required

Response

Success

idinteger

Unique payment token identifier for the Mastercard Digital Enablement Services (MDES) or Visa Digital Enablement Program (VDEP) card.

walletIdstring nullable

Unique identifier of the wallet provider this payment token is linked to (e.g., APPLE, ANDROID, SAMSUNG).

walletProviderstring nullable

Name of the wallet provider this payment token is linked to (e.g., Apple, Android, Samsung).

tokenPANstring nullable

The funding PAN (card PAN), with only the last four digits shown.

tokenisedDatestring nullable

Tokenised date. Format YYYY-MM-DD.

expiryDatestring nullable

Token expiry date. Format YYYY-MM-DD.

tokenTypestring nullable

The payment token type. For example: C (Contactless Device PAN), CF (Card on File PAN).

deviceTypestring nullable

The type of technology linked to the token. For example: F (Fob or key-fob), M (Mobile phone), P (Personal computer).

deviceNamestring nullable

Name the cardholder assigned to the device in the wallet.

activationCodestring nullable

The merchant name (name of the token requester). For example: Amazon, Apple Pay, Google Pay. Activation Code.

threddDecisionAtstring nullable

Thredd Decision at Date and time.

threddDecisionstring nullable

Thredd Decision

creatorTokenReferencestring nullable

The token creator's unique reference for this payment token. (Mastercard Token Unique Reference (TUR) and Visa Token reference ID.)

cardUsageGroupstring nullable

The Usage Group of the card linked to the payment token. The usage group determines where the payment token can be used (e.g., Point of Sale terminal, ATM, ecommerce).

paymentTokenUsageGroupstring nullable

The Payment Token Usage Group of the card linked to the payment token. Defines configuration options specific to the provisioning of a digital payment token. For details, see the Tokenisation Guide.

paymentTokenUsageGroupIdinteger nullable

Identifier of the payment token usage group linked to the payment token. When null, the issuer has not configured a usage group for the token.

walletAccountScoreinteger nullable

Risk score for the account, received from the wallet provider during digitisation: 1 = highest risk; 2 = higher risk; 3 = neutral; 4 = lower risk; 5 = least risk.

walletDeviceScoreinteger nullable

Risk score for the device received from the wallet provider during digitisation: 1 = highest risk; 2 = higher risk; 3 = neutral; 4 = lower risk; 5 = least risk

walletReasonsstring nullable

Wallet service provider tokenization recommendation reason codes. For a list of Wallet Reason codes, refer to the Get Card Payment Token Details documentation.

transactionIDinteger nullable

The unique Transaction ID.

responseCodestring nullable

Response code, indicating the status of the request.

transactionDatestring nullable

Date and time when tokenised, in the format: yyyy-mm-ddhhmmss.

cardAcceptorNameLocationstring nullable

The name and location of the entity accepting the card payment.

bnReferencestring nullable

Used to convey additional information related to a transaction (DE063 field), such as a Banknet reference number, which can be used for transaction tracking or reconciliation purposes.

mtidstring nullable

The transaction Message Type Identifier (MTID). For example: 0100 (authorisation)

ehiRequestTimestring nullable

The External Host Interface (EHI) request time.

ehiResponseTimestring nullable

The External Host Interface (EHI) response time.

activationMethodstring nullable

Which activation method was used: 0 = none; 1 = SMS to mobile phone; 2 = email; 3 = cardholder called an automated call centre; 4 = cardholder called a human call centre; 5 = website; 6 = mobile application; 7 = voice phone call

activationStatusstring nullable

Token activation status.

merchantNamestring nullable

Merchant Name.

linkedTokeninteger nullable

Linked 16-digit public token

deviceLanguagestring nullable

Device language code.

locationstring nullable

Device latitude and longitude.

endOfPhoneNumberstring nullable

Device telephone number.

firstnamestring nullable

Cardholder firstname.

lastnamestring nullable

Cardholder lastname.

finalDecisionBystring nullable

Final decision taken by.

panSourcestring nullable

The source of the clear PAN used to send in the Tokenisation Authorisation Request transaction to create this new PaymentToken..

creatorstring nullable

Creater of the payment_token.

txnStatusChangedstring nullable

Date/time that txn_status was last changed. Format yyyy-mm-ddhhmmss.

activationCodeExpdatestring nullable

Date/time when activation code expires. Format yyyy-mm-ddhhmmss.

replacementCountinteger

Number of time replaced.

oldExpDatestring nullable

Old expiry date.

deviceIDstring nullable

Device ID.

deviceIPstring nullable

Device IP.

walletAccountHashstring nullable

Wallet Account Hash.

digitisationReferencestring nullable

Creator Digital reference.

termsAndConditionsstring nullable

Terms and Conditions.

externalStatusSetBystring nullable

External status set by

creatorPanReferencestring nullable

Creator pan reference

groupCodestring nullable

Payment token usage group rule name

groupDescriptionstring nullable

Payment token usage group rule description

panSourceDescriptionstring nullable

Description retrieved from the desc_item_value table, corresponding to the pan_source in paymenttoken table