Skip to main content
Visa Card Eligibility Service

How to use VCES

Available for use by:
Issuer banks Acquirer banks Merchants Independent developers Issuer banks for small businesses

Visa Card Eligibility Service (VCES) lets Visa clients check eligibility for Visa cardholders, supporting targeted distribution of consumer value propositions.

Integrate with the Web Service or iFrame API by following the endpoint reference, request and response attribute catalogs, and workflows for your chosen integration path.

Visa Card Eligibility Service (Web Service) flow

Intended for partners with Payment Card Industry Data Security Standard (PCI DSS)-compliant access to Primary Account Number (PAN) data who use Message Level Encryption (MLE) to safeguard user data.

  1. Call the Validate operation to check if the cardholder has access to the benefit, offer, or promotion.
    • If eligible for the program, a success response is returned.
    • If ineligible, an ineligible response is returned.
  2. If eligible, direct the cardholder to the benefit, offer, or promotion details. The cardholder goes through the purchase flow and enters their card details on your checkout page.
  3. Optionally, call the Prepay operation to check if the credential entered by the cardholder at checkout is the same one that was initially validated. Based on the success of this call, submit the credential information to your payment provider.
  4. After the payment has been processed successfully, call the Redeem operation to notify Visa Card Eligibility Service (VCES) the cardholder completed the purchase. The Redeem operation is the final step after the completion of all business processes on your side.

    If needed, the Redeem operation can be invoked to cancel a redemption by decrementing the redemption counter using a Reverse Redemption call.

Visa Card Eligibility Service (iFrame) flow

Designed for clients who don't handle Primary Account Number (PAN) data directly. This requires invoking an iFrame instance with a URL provided by the Visa Product office during the engagement call.

  1. Call the iFrame Token operation to obtain a token.

    The token obtained in this step is sent as a parameter to invoke the Visa Card Eligibility Service (VCES) iFrame in the next step. This token has a 1:1 relationship with the correlation ID you generated.

  2. Invoke an iFrame instance by appending the token to the iFrame URL provided during onboarding.
  3. Customize the look, tone, and feel of the iFrame through CSS hosted on your side. Provide the externally hosted CSS file URL as part of onboarding to Certification (CTE) and Production (PROD).
  4. Have the cardholder enter their full 16-digit PAN on the iFrame and submit it.
  5. VCES validates the card based on the eligibility criteria configured for the program and sends a callback of ?token to your pre-defined callback URL, also provided as part of onboarding to CTE and PROD.
  6. Once you receive the callback, call the Validate Result operation to check the eligibility status of the card.

    The response of this operation lets you know whether the card is eligible for the offer or benefit.

    • If eligible for the program, a success response is returned.
    • If ineligible, an ineligible response is returned.
  7. If eligible, show the cardholder the benefit, offer, or promotion details. The cardholder goes through the purchase flow and enters their card details on your checkout page.
  8. After the payment has been processed successfully, call the iFrame Redemption operation to notify VCES the cardholder completed the purchase. This operation is the final step after the completion of all business processes on your side.

    If needed, the iFrame Redemption operation can be invoked to cancel a redemption by decrementing the redemption counter using a Reverse Redemption call.

Visa Card Eligibility Service (iFrame) flow – revalidate

To revalidate a credential that has already had an Alias ID generated against it, perform these steps.

  1. Call the Validate iFrame operation to revalidate a Primary Account Number (PAN) previously entered by the cardholder, passing the Alias ID returned from Validate Result. This lets you check the eligibility of a PAN without having the cardholder re-enter their card number in the iFrame.
  2. Optionally, call the Prepay iFrame operation to check if the card entered by the cardholder is the same one used initially to check the access privilege. This requires an Alias ID to be passed in the Prepay iFrame call. Based on the success of this call, submit the card information to your payment provider.
  3. Call the Redeem iFrame operation to redeem the Validate iFrame transaction, passing the Alias ID returned from Validate Result.

    This lets you redeem the transaction without having the cardholder re-enter their card number in the iFrame.

    If needed, the Redeem iFrame operation can be invoked to cancel a redemption by decrementing the redemption counter using a Reverse Redemption call.