Skip to main content
Visa Card Eligibility Service

Before you begin

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

Before integrating with the Visa Card Eligibility Service (VCES) API, confirm you meet the eligibility requirements for your chosen API variant and know how to access the sandbox environment.

Review the prerequisites, environments, and environment hosts and URL structure before you start building against VCES.

Prerequisites

Confirm you meet the eligibility and technical requirements for your chosen Visa Card Eligibility Service (VCES) API variant before you begin integration.

Eligibility requirements

Confirm you meet these eligibility requirements before integrating with VCES:

  • Partners, issuers, merchants, acquirers, and developers may use VCES.
  • The Visa Card Eligibility Service (iFrame) API does not require Payment Card Industry Data Security Standard (PCI DSS) compliance.
  • The Visa Card Eligibility Service (Web Service) API requires PCI DSS compliance with an active Attestation of Compliance (AoC).
  • All users must have a Business ID (BID) with Visa.
  • Partner agreements are generally required in addition to Visa Developer Center (VDC) agreements to cover your specific use case and terms.
  • Clients using the Web Service API must configure Message Level Encryption (MLE).

Development environment setup

Your development environment must support these technical requirements:

  • HTTPS Support – All API communications must use HTTPS.
  • JSON Processing – Your application must handle JSON request and response formats.
  • Credential Management – Your application must securely store your Two-Way SSL certificates, private keys, and Message Level Encryption key pair.

Environments

Visa Card Eligibility Service (VCES) has these environments available in Visa Developer Center (VDC): Sandbox, Certification, and Production. The progression through each is linear: an environment may not be skipped.

Sandbox (SBX)

Clients learn the APIs, how they connect to each other, and build basic flows. Test data is provided in the project, which clients may leverage. The main goal of SBX is to ensure clients can establish Mutual Transport Layer Security (mTLS) connectivity and Message Level Encryption (MLE) protocols when using the Web Service APIs. The test data cannot be changed for any client.

To move to the next environment, clients must complete all the forms in the project, undergo Office of Foreign Assets Control (OFAC) sanction screening, and complete their engagement call with the VCES Product office. iFrame clients must have their CSS and callback URLs configured in their system. Web Service clients must have configured Message Level Encryption in their flows and provide a valid Payment Card Industry Data Security Standard (PCI DSS) Attestation of Compliance (AoC) for Report on Compliance (RoC) or Self-Assessment Questionnaire (SAQ), depending on the client's PCI Level.

Certification (CTE)

Clients are provided with a custom Vendor Unique ID (VUID), which Visa will configure, for more robust testing. Not all response attributes are available in this environment, and some are mocked. If using the iFrame, clients must provide working CSS and callback URLs to be configured in the Vendor Unique ID. To move to the next environment, clients must complete all the forms in the project, have a valid, active BID with Visa, and provide the VCES Product office with a copy of their signed, executed agreement with Visa. This last step is required if a client is not going to be billed using the standard Fee Schedule presented at time of promotion. Visa strongly recommends that your Visa representative perform User Acceptance Testing (UAT) in this environment before moving forward.

Production (PROD)

Clients test their end-to-end flows, with full response attribute data returned, where applicable. Another set of URLs for CSS and callback are provided by clients if using the iFrame APIs. Your Visa representative performs a final round of UAT in this environment to confirm the implementation works as designed.

See Environment hosts and URL structure for the base host and endpoint path values for each environment.

Environment hosts and URL structure

Each Visa Card Eligibility Service (VCES) environment has its own base host, endpoint paths, and iFrame widget URL. See Environments for the requirements to promote from Sandbox to Certification to Production.

Base hosts by environment

Each VCES environment has its own base host:

Environment Base Host
Sandbox (SBX) https://sandbox.api.visa.com
Certification (CTE) https://cert.api.visa.com
Production (PROD) https://api.visa.com

See VCES API endpoints reference for the endpoint paths to append to these base hosts.

Visa-hosted iFrame URLs

Clients using the iFrame API load the VCES iFrame using the token returned by the iFrame Token operation, appended to the appropriate environment URL.