Visa Digital Benefits Platform (VDBP) APIs can be used in the Sandbox (SBX) environment by any developer. The environment includes test data to simulate request and response payloads. For more details, please reach out to [email protected].
All projects using VDBP will go through a review and approval process at Visa to move to the Certification (CTE) and Production (PROD) environments. Please reach out to your Visa account representative early in the process to ensure your application meets the criteria permitted for the use of VDBP in these environments and begin executing an agreement.
The product provides four APIs: Benefit File, Card Account, Card Product and Flex Choice.
The following table lists the regional availability for Visa Digital Benefits Platform. To view availability of all products, refer to the Availability Matrix.
| North America | Asia-Pacific | Europe | CEMEA | LAC | Notes |
|---|---|---|---|---|---|
|
North America : Available in Canada |
Visa Digital Benefits Platform (VDBP) is a turnkey solution benefits management platform with digital APIs to facilitate cardholder servicing while delivering differentiated benefits experience at the card level.
VDBP facilitates Cardholder communication through a white-labeled web portal and provides Benefits APIs that can be used by Issuers to integrate Benefits into their existing frontend channels such as an internet banking or mobile app.
Additionally, VDBP can support Issuers who have already combined a series of Benefits into a Card value proposition, as well as Issuers who want to build something new. For Issuers building a new Card value proposition, VDBP can provide Benefits configuration functionality that can streamline the process.
Card Benefits
Card Benefits are important product differentiators. They are tools for customer acquisition and can drive spend. Visa offers Issuers the ability to manage propositons with:
To begin, Issuers can choose from Visa’s inventory of existing Benefits or source their own. Benefits sourced directly by the Issuer can be integrated with Visa’s Benefit platform. After the Benefits are loaded, a web-based administration tool enables Issuers to combine individual Benefits into card value propositions. Once defined, Issuers can associate the card value proposition with specific Cardholder segments – using Bank Identification Numbers (BINs), Account Ranges, or Rewards Program Identification Numbers (RPINs).
Benefit FileThis endpoint retrieves the files associated to a benefit. The files are fetched based on the benefit. It is a GET request that requires the benefit id, the date, language, and file type as a parameter in the URL. The response will include a pdf or text file that can be downloaded. The benefit details are returned in a structured JSON format for easy parsing and integration with other systems.
Card AccountThis API has two endpoints: Card Account Benefits and Card Account Benefit Details.
Card Account Benefits
This endpoint is designed to return a set of benefits that a PAN (Primary Account Number) qualifies for based on an "as of date" and other input parameters. This endpoint requires the user to have access to the PAN and to be PCI DSS (Payment Card Industry Data Security Standard) compliant. The primary purpose of this endpoint is to provide a list of qualifying benefits in VDBP along with other card attribute data. This helps in offering a personalized set of benefits to each cardholder based on their card type, usage, and other factors.
Card Account Benefit Details
This endpoint is designed to return detailed information associated with a specific PAN (Primary Account Number) and benefit ID. This endpoint requires that the user has access to the PAN and is PCI DSS (Payment Card Industry Data Security Standard) compliant. This endpoint is primarily used to retrieve details on a specific Benefit ID and PAN combination. It provides comprehensive information about a particular benefit that a cardholder is eligible for, aiding in the understanding and utilization of the benefit.
Card ProductThis API has two endpoints: Card Product Benefits and Card Product Benefit Details.
Card Product Benefits
This endpoint is designed to return a set of benefits that a specific combination of card attributes qualifies for based on an "as of date" and other input parameters. This endpoint takes into account various card attributes such as card type, issuer, and other relevant parameters to determine the eligible benefits. It provides a list of qualifying benefits for a particular card product, enabling a personalized and tailored approach to benefit provision based on the card's characteristics.
Card Product Benefit Details
This endpoint is designed to return detailed information associated with a specified benefit. This endpoint requires the benefit id as an input parameter and provides comprehensive data about that particular benefit. The data returned can include information such as the benefit description, eligibility criteria, usage limitations, and other relevant details. This endpoint is crucial for users looking to understand the specifics of a particular benefit.
Flex ChoiceThis API has two endpoints: Flex Choice Register and Flex Choice Persist.
Flex Choice Register
This endpoint is used to register a card in the system, making it eligible for selecting benefits. This endpoint receives card details as input, verifies the information, and then adds the card to the system. Once the card is registered successfully, it becomes eligible for benefit selection based on the card type and other criteria. This endpoint is crucial for onboarding new cards into the system and ensuring they can access the appropriate benefits.
Flex Choice Persist
This endpoint is designed to enable the selection of benefits for a card based on what is available for that particular card. This endpoint receives the card information and the selection of benefits as input, and updates the database with these selections. It ensures that only the benefits that are available for the card can be selected, maintaining the integrity of the data and the consistency of the system. This endpoint is crucial for managing card benefits and for providing a customized experience for each cardholder.
Start a Project
API Overview
API Reference
Working with Visa APIs