Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Step 2 – check card eligibility

Check card eligibility validates that a card can be tokenized with a payment network TSP (for example, VTS or MDES).

In this step, the TSH backend asks the issuer backend to confirm eligibility and return the product configuration to use for Tokenization.

Check card eligibility flow.

See checkCardEligibility in the API reference.

Use the notes below to interpret the request and response parameters.

Request parameters

Parameter
Description

x-correlation-id

Correlates an enrollment session between the TSH backend and the issuer backend. The TSH backend first sends it in requestCardEligibility. Store it and use it to link subsequent requests in the same session.

cipheredCardInfo

Contains the encrypted FPAN and expiry date for the card to tokenize. CVV2 is not provided at this stage.

issuerCardRefId

Provides a card reference managed by the issuer backend. Use it instead of cipheredCardInfo for single-badge domestic scheme Tokenization when the card was already tokenized, or for silent Tokenization (for example, provisioning the same token from a phone to a watch). Do not use this parameter for Visa or Mastercard Tokenization (single badge or cobadge). In most cases, the TSH backend already knows this value from a previous Tokenization.

Response parameters

Parameter
Description

issuerCardRefId

Unique identifier of the FPAN in the issuer backend. Return the same value on every subsequent requestCardEligibility call for the same FPAN. You can update this value later using replaceCardReq.

productId

Identifies the card product profile configured in the payment network TSP. Configure it in the TSP portal. In VTS, it maps to the card metadata profile ID defined in VCMM. In MDES, it maps to the issuerProductConfigId defined in BPMS.

The payment network TSP uses productId to return the right card art, card metadata, and terms and conditions to the token requestor.

For Mastercard, eligibility is always enforced by MDES.

The TSH backend still calls the issuer backend to keep a consistent API across payment networks.

If your BIN ranges are ambiguous, always return productId. The TSH backend forwards it to MDES so MDES can return the correct card metadata.

Last updated

Was this helpful?