Skip to main content
Visa Card Eligibility Service

Glossary

API Developer Guide

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

Account Funding Source

An attribute defined at issuance indicating how the account is funded (for example, credit, debit, or prepaid); returned as acctFundSrce when configured.

Account Range

A range of account numbers defined at issuance, usable as an eligibility criterion.

Alias ID (aliasId)

Visa Card Eligibility Service (VCES) generates this unique 36-character Universally Unique Identifier/Globally Unique Identifier (UUID/GUID), which stands in for a credential – a Primary Account Number (PAN), a Visa Token Services (VTS) token, or a Token Account Number (TAN) – in later API calls. An Alias ID lets a client revalidate or redeem a credential without having the cardholder re-enter their card number. It is mutually exclusive with PAN/TAN in a request.

Attestation of Compliance (AoC)

The Payment Card Industry Data Security Standard (PCI DSS) compliance document a client files annually, either a Self-Assessment Questionnaire (SAQ) or a Report on Compliance (RoC), depending on transaction volume and PCI Level.

Bank Identification Number (BIN)

The range-defining prefix of a card number, set at issuance; usable as an eligibility criterion.

Business ID (BID)

Visa assigns a business identification number to an issuer. Every Visa Card Eligibility Service (VCES) user must hold an active BID. The BID is used as an eligibility criterion and is returned in the response as issuerBid.

Card Group ID / Card Group Type

Account Level Management groupings usable as eligibility criteria.

Card ID (cardId)

A Visa Card Eligibility Service (VCES)-generated unique numeric ID for a credential. It's not used in any API call, but persists as a semi-permanent identifier for that credential.

Certification (CTE)

The second of the three Visa Card Eligibility Service (VCES) environments; uses a Visa-configured custom Vendor Unique ID (VUID) and partially mocked response attributes.

Correlation ID (correlationId)

A partner-generated unique identifier, 10-100 characters long, that ties together the API calls belonging to a single eligibility transaction, such as linking a Validate call to its corresponding Prepay and Redeem calls.

Eligibility Level

An indicator of which tier of eligibility criteria a credential satisfies within a Vendor Unique ID (VUID). Visa Card Eligibility Service (VCES) returns the highest eligibility level a credential qualifies for.

Entity to Be Billed

The response object identifying who is billed for a redemption (for example, issuer vs. merchant), returned when a program has billing configurations, via the memberCharge and additionalRedemptionCharges fields.

extendedData

A free-form request field for offline reporting; must not contain Personally Identifiable Information (PII) or Personal Accountholder Information (PAI) or the characters , : | ;.

iFrame

The Visa Card Eligibility Service (VCES) API variant for clients who don't handle Primary Account Number (PAN) directly; the cardholder enters their PAN into a Visa-hosted iFrame instance instead.

Is PAN (isPan)

A request flag, true by default, indicating whether the submitted credential is a Primary Account Number (PAN); set to false when it may be a Visa Token Services (VTS) token.

Message Level Encryption (MLE)

A second, independent layer of encryption on top of Mutual Transport Layer Security (mTLS) that protects the request/response payload itself; required in all environments for the Web Service API.

Mode (mode)

A request field on Redeem, iFrame Redemption, and Redeem iFrame; 0 (default) for a redemption, 1 for a reverse redemption.

Mutual Transport Layer Security (mTLS)

Also known as Two-Way SSL or Mutual Authentication. An authentication method where the client and server each present certificates during the Transport Layer Security (TLS) handshake; no token or API key is required.

Number of Additional Redemptions (numberOfAdditionalRedemptions)

A request field for the count of extra redemptions being validated in the same transaction (for example, guests).

Platform Code

The broadest product-family categorization used for account-level processing.

Primary Account Number (PAN)

The primary account number, typically a 16-digit card number, submitted to Visa Card Eligibility Service (VCES) to identify a credential. It is mutually exclusive with a Token Account Number (TAN) or Alias ID in a request.

Production (PROD)

The third and final Visa Card Eligibility Service (VCES) environment; full response data, end-to-end testing, and go-live.

Redemption

The act of reporting to Visa Card Eligibility Service (VCES) that a cardholder has consumed an entitlement, performed with the Redeem, iFrame Redemption, or Redeem iFrame operation; tracked against configured limits.

Redemption Details (redemptionDetails)

The response object describing a credential's redemption limits and usage, including allowed, used, eligible, pooling, and unlimited redemption information.

Report on Compliance (RoC)

A Qualified Security Assessor (QSA) independently performs this Payment Card Industry Data Security Standard (PCI DSS) assessment, required of PCI Level 1 partners in lieu of a self-assessment.

Reverse Redemption

A call to a redemption endpoint with Mode set to 1, used to cancel a redemption and decrement the redemption counter.

Rewards Program Identification Number (RPIN)

A Visa identifier that Account Level Management defines, usable as an eligibility criterion.

Sandbox (SBX)

The first Visa Card Eligibility Service (VCES) environment; fixed test data, used to prove out API connectivity, Mutual Transport Layer Security (mTLS), and Message Level Encryption (MLE).

Self-Assessment Questionnaire (SAQ)

The Payment Card Industry Data Security Standard (PCI DSS) self-assessment type most Visa Card Eligibility Service (VCES) Web Service clients (below the top volume tier) file, submitted as an Attestation of Compliance (AoC) for SAQ-D.

Status Code / Status Description (statusCode / statusDescription)

The machine-readable code and human-readable text describing the result of any Visa Card Eligibility Service (VCES) operation. See VCES status codes and descriptions.

Token Account Number (TAN) (tokenAccountNumber)

A 16-19-digit Visa Token Services token submitted to Visa Card Eligibility Service (VCES) in place of a Primary Account Number (PAN) to identify a credential. It is mutually exclusive with PAN and Alias ID in a request.

Validate

The eligibility-check operation; the first step in both the Web Service and iFrame flows.

Vendor Unique ID (VUID)

A unique identifier containing the eligibility requirements and custom settings for a program. Also referred to as Program ID or Promotion ID. Maximum 20 characters.

Visa Developer Center (VDC)

The Visa developer portal and API gateway through which Visa Card Eligibility Service (VCES) projects, credentials, and environment promotion are managed.

Visa Token Services (VTS)

The Visa tokenization service; VTS tokens can be submitted in place of a Primary Account Number (PAN) via tokenAccountNumber.

Web Service

The Visa Card Eligibility Service (VCES) API variant for Payment Card Industry Data Security Standard (PCI DSS)-compliant clients with direct Primary Account Number (PAN) access; requires Message Level Encryption (MLE) in all environments.

X-Pay Token

A Hash-based Message Authentication Code using SHA-256 (HMAC-SHA256)-based API Key-Shared Secret authentication method, sent in the x-pay-token header.