Skip to main content
GET
Lists tokens for a card

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-audit-user
string

Optional audit user header

Path Parameters

cardId
string<uuid>
required

CardId of the card for which tokens are requested.

Query Parameters

fetchFromCardScheme
boolean
default:true

If true, tokens will be fetched directly from the card scheme (e.g., Mastercard, Visa).


If false, tokens will be fetched from the internal system.


includeCardSchemePayload
boolean
default:false

If true, the response will include the raw payload from the card scheme for each token (if available).


If false, the card scheme payload will be omitted from the response.


Response

Successful lookup of tokens for given card id.

tokenUniqueReferenceId
string

A unique identifier for the token assigned by the Token Service Provider (TSP) (eg. Visa or MC) to manage the lifecycle of the token.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
Example:

"DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"

tokenRequestorId
string

Identifier used by merchants or wallet providers to request tokens from the TSP.

Example:

"212345678"

tokenRequestor
enum<string>

Code of the wallet provider or merchant that requested the token (APPLE_PAY /GOOGLE_PAY/SAMSUNG_PAY/OTHER). OTHER is used for tokens not linked to a wallet provider, such as merchant tokens (credential-on-file, subscription payments) or cloud tokens (e.g., Mastercard APANs).

Available options:
APPLE_PAY,
GOOGLE_PAY,
SAMSUNG_PAY,
OTHER
Example:

"APPLE_PAY"

status
enum<string>

Current status of the token:

  • ACTIVE - Available for payments
  • DEACTIVATED - Permanently deactivated
  • INACTIVE - Waiting for activation
  • SUSPENDED - Temporarily not available for payments
Available options:
ACTIVE,
DEACTIVATED,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

tokenSuffix
string

The last 4 digits of the tokenised PAN (DPAN) used for display and identification purposes.

Example:

"7890"

deletedFromConsumerApp
boolean

If the token was deleted from the consumer app

authorizationDecision
enum<string>

The wallets common name for authorization decision.

Available options:
GREEN,
YELLOW,
ORANGE,
RED
Example:

"YELLOW"

cardId
string<uuid>

The id of the card associated with the token.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

createdAt
string<date-time>

The timestamp when the token was created by the TSP.

updatedAt
string<date-time>

The timestamp of the most recent update to the token’s status.

updateCount
integer

The version number of the entity.

Example:

1

cardSchemePayload
string

The raw payload from the card scheme, if available.

deviceInfo
object

Device information.