Visa Merchant Offers Resource Center Documentation

Ready to start coding?

Things to Know

The Visa Merchant Offers Resource Center (VMORC) provides approved and active offers specific to a user account. All functions supported by the VMORC APIs are READ-ONLY. All responses are returned in a JSON format.

Offers in the VMORC APIs contain a set of required and optional fields. The following fields are required from each VMORC offer:

  • Program
  • Language
  • Merchant Name
  • Offer Title
  • Offer Validity Dates
  • Promotion Date Range
  • Promotion Channels
  • Redemption Channels
  • Offer Short Description
  • Offer Copy
  • Merchant Terms & Conditions
  • Visa Terms & Conditions
  • Merchant Logo
  • Offer Source
  • Redemption Countries
  • Promoting Countries
  • Card Products
  • Card Payment Types
  • Business Segments
  • Categories/Sub-Categories
  • Offer Type

Some offers may contain information tailored for specific consumer projects.

The VMORC APIs can be used by any developer in the sandbox. The sandbox uses one user account to retrieve sample data and offers. The production environment stores provide offers that are valid to redeem. Currently, only Visa issuers can use the VMORC APIs in production. Each user account must be pre-approved for production and configured for each project's needs. Contact developer@visa.com for further information.

The merchant offers that are available through VMORC are collected from merchants around the world as a service to clients and their cardholders. The offers are provided by the merchant and not by Visa. Visa expressly disclaims any responsibility for their content or compliance with the laws of any country.

No offer reproduced from VMORC may be changed or modified in any manner, either with respect to the offer content or its accompanying terms and conditions. Issuers are solely responsible for any use of the merchant offers set forth herein. Before downloading or making these merchant offers available to your cardholders, Visa strongly recommends that you consult with your own legal counsel. This is to determine if the offers comply with your policies and the laws of each jurisdiction in which the respective offers will be made available.

Availability

The following table lists the regional availability for Visa Merchant Offers Resource Center. To view availability of all products, refer to the Availability Matrix.

Available in entire region

Limited availability in region

Not available

Product Name Availability Notes
Visa Merchant Offers Resource Center
Product Name Availability Notes
Visa Merchant Offers Resource Center
Product Name Availability Notes
Visa Merchant Offers Resource Center
Product Name Availability Notes
Visa Merchant Offers Resource Center
Product Name Availability Notes
Visa Merchant Offers Resource Center

Getting Started

The Visa Merchant Offers Resource Center (VMORC) is a central offer repository that gives issuers an easy way to promote merchant offers to their cardholders. VMORC is a multilingual application used by various teams worldwide to store offers as they are procured. Additionally, VMORC provides an Application Programming Interface (API) for issuers to extract offers to display on custom applications or pages. Since VMORC simultaneously manages the offer entry and distribution processes, issuers are provided access to the latest offers as soon as they become available.

Main features include:

  • Central offer data store for global, regional and local merchant offers
  • Ability to store, display and search in multiple languages
  • Ability to export single or multiple offers in multiple formats
  • Discards offers after a configurable time
  • Delivers basic reports that capture user interaction in the offer data store
  • Numerous API filters and combinations to serve various types of offer responses to consumer applications

Visa Merchant Offers Resource Center (VMORC) is a multifunctional system used by agencies and Visa teams to enter and share offers. As a developer, you can retrieve data offers for your customized web and mobile applications.

If you are new to the VMORC API services, you can filter and run the following kinds of data queries.

  • All available offers: This is the most comprehensive request and returns with all accessible offers.
  • Offer IDs: This request is made when you are interested in a specific offer and its translations. You must know the offer ID (an identifier for offer and its translations) and pass it in the request.
  • Content IDs: This request is made when you are interested in a language-specific offer. You must know the content ID (a language-specific identifier) and pass it in the request.
  • Reference Data: Prior to making an offer-related request, you must first query the Reference Data API to determine available reference data options and its IDs. You can then make the filtered offers request by passing the desired reference data IDs in the request.

The following sections provide a general background about how offers are acquired and made available through the Offers Data API and retrieved from the Reference Data API.

Understanding the Offer Entry Process

The VMORC Offer Entry Process involves the following steps on how offers are acquired and made available through the API. 

  1. Merchant offers are procured by Visa and agencies offline.
  2. Offers are entered into the VMORC system through its UI interface.
  3. Offers are reviewed through the UI interface by appointed VMORC users.
    Note: If all the offer information is correct, the offer is approved in VMORC.
  4. Offer images are deployed to a publically available server. The offer details are made available through the Offers Data API.

Accessing the Published Offer Data

Once the offer is made available to the issuer through the VMORC API, you can retrieve the recently published offer data. As shown below, the VMORC API process includes steps which involve acquiring the offer data to apply to your customized web and mobile applications.

  1. The issuer makes a set of requests to the VMORC Offers Data API to retrieve offer data. To make a filtered offer request, the issuer must make a request to the Reference Data API to get a list of available filtered options and their key values. The issuer may then make a filtered offer request by applying the desired filters in the parameters of the request.
  2. VMORC processes the request and determines the data the user account can access. For offer requests, the system only returns offers which the issuer has permission to view. For reference data, the system only returns filtered options associated to at least one accessible offer.
    Note: All responses are returned in JSON format.
  3. The issuer designs and develops a customized web and mobile application using the VMORC offers and data.As noted, there are two available types of VMORC API services: Offers Data API and Reference Data API.
  4. Offers Data API

    The Offers Data API retrieves offer details that are accessible to the caller. The caller may query for specific sets of offers by adding filters. Filtered offer requests may be created by adding offer content IDs, offer IDs and by reference data IDs. For specific details related to the Offers Data API, reference the VMORC API Reference.

    Reference Data API 

    The Reference Data API retrieves offer criteria that is accessible to the caller. The caller may query different business segment categories, such as commercial, consumer and small business. This information is used to create filtered offer data requests. For specific details related to the Reference Data API, refer to the VMORC API Reference.

How Does It Work?

The VMORC APIs provide developers a quick and easy way to retrieve offer information to display on web or mobile applications. 

Developers programmatically communicate with the VMORC API services through an API account. Administrators entitle each API account access to offers by "country" (offers promoted in that country) or by “programs” (offer collections).

Once communication with VMORC is established, developers submit requests to the Offers Data API to retrieve all accessible offers. Developers may further refine the offer response by specifying filter IDs in the offer request, such as specific business segments or card products. The Reference Data API can be used to acquire the IDs to make filtered offer requests.

Refer to the API Reference link for more information.

Why Use It?

Provide Additional Value to Current Cardholder Communications Platforms

VMORC provides issuers with offers that they can incorporate into their own programs or projects for a seamless and simple consumer experience.

APIs Included

Offer Data API

The Offer Data API allows issuers to retrieve the offer data available to them or filtered by offer attributes.

Reference Data API

The Reference Data API provides developers a quick and easy way to retrieve reference information from VMORC. These values are mainly used in offer filtering criteria and values.

Retrieving Offers Data

There are four methods which issuers can retrieve offers data:

  • Request for all available offers
  • Request for offers by Offer ID
  • Request for offers by Content ID
  • Request for offers by Reference Data

Request for all available offers:  This request prompts the VMORC Offers API to return all offers that the issuer may access.

Request for offers by Offer ID: This request prompts the VMORC Offers API to return all offers with a specific Offer ID. Note: All offers and their translations have an identical Offer ID value.

Request for offers by Content ID: This request prompts the VMORC Offers API to return offers with a specific Content ID. Each language specific offer has a unique Content ID value.

Request for offers by Reference Data:The issuer must first query the VMORC Reference Data API for available reference data values and IDs. Using the reference data response, the issuer prompts the VMORC Offers API to return offers that match the Reference Data IDs. Note: This is a filtered offer request.

Retrieving Reference Data

There are three kinds of data which issuers can retrieve from the VMORC Reference Data API:

  • Request for Reference Data
  • Request for Merchants
  • Request for Merchant Addresses

The following diagrams provide descriptions that outline the process for requesting reference data, merchant and merchant addresses.

Request for Reference Data: The information returned in this request allows the issuer to build filtered offer requests. (See Accessing the Published Data in the section above). The service allows the issuer to query for specific reference data types, reference data languages and reference data relevant to specific programs.

The supported VMORC Reference Data types include:

  • Business Segment
  • Card Payment Types
  • Card Products
  • Categories and Sub-categories
  • Languages
  • Program
  • Promotion Channel
  • Redemption Channel
  • Region
  • Promotion Countries
  • Redemption Countries

Request for Merchants: The information returned in this request allows the issuer to build filtered offer requests by a specific merchant. The service only returns merchants if the issuer is able to access at least one of the offers of the merchant. The issuer may query for merchants available within a specific program.

Request for Merchant Addresses: The information provided in this request informs the issuer of merchant addresses associated with their accessible offers. The service requires the issuer provide merchant IDs to retrieve their corresponding addresses. 

Note: Reference Data values may differ between the sandbox environment and production.

Security and Authentication Requirements

The VMORC APIs use mutual SSL authentication and channel encryption, which requires the caller to obtain a user ID and password, as well as, install a Public Key Infrastructure (PKI) certificate issued by Visa. Test credentials can be obtained online in the Project Dashboard for sandbox testing. Production credentials will be supplied to you as part of the production on-boarding process. Contact developer@visa.com for more information or to begin the production on-boarding process.

FAQs

Various teams throughout the world use the VMORC APIs. This section lists a few of the most commonly asked questions and answers.

Q: How do I request offers provided by specific merchants? 

A: First, you must make a request to the reference data API service for available merchant IDs. You then need to make a filtered offer request to the Offers Data API, providing the desired merchant IDs in the request.  

Q: The offer response can return a promotion date and a redemption date. What’s the difference?

A: The promotion dates indicate the day or days when the offer can be promoted, while the redemption date range indicates when the cardholder can redeem the offer.

Q: What’s the difference between Offer IDs and Offer Content IDs?

A: Each offer is assigned both an Offer ID and a Content ID. Each time an offer is edited, the Content ID updates to a new value. An Offer ID remains the same through each offer update.

In addition, offers translated into multiple languages provide the identical Offer ID.

Best Practices

This section lists information regarding VMORC best practices which issuers should be aware of in order to build a successful and optimized project.

  • Scheduled maintenance is periodically conducted on VMORC production. The VMORC API services are unavailable during specific scheduled times.
  • You are encouraged to cache offers in a middleware tier to ensure content is still available during maintenance times.
  • When referencing specific offers (for instance, in the configuration file), use the Offer ID. Offer IDs remain constant throughout offer updates, so the reference will not need to be changed when updated.

Recommendations and requirements displayed, may vary based on offers promoted. In general, you may want to display the following fields:

  • Validity Dates
  • Merchant Name
  • Merchant Logo
  • Offer Short Description
  • Offer Copy
  • Merchant Terms
    Note: This field can be combined with Visa terms under a unified “Terms and Conditions“ label.
  • Redemption URL
    Note: Add a Terms and Conditions button or a terms to redeem link.