Open API >Offers & Benefits >Merchant Offer
Merchant Offer
Offers & Benefits Developer Acquirer Issuer
Merechant's Offer provides massive offer information of UnionPay international, as well as the merchant and store information related to the offer.
API Introduction
API Introduction
What is it?

Merchant Offers API provides access to UnionPay International's central offer repository, so as to enable users to promote merchant offers to their cardholders on multilingual custom applications or pages. All the information is simultaneously managed and updated for users to access the latest offers as soon as they become available.

Key Features

In-depth Cooperation

It helps API users to cooperate closely with partners who display UnionPay international offers and provide offer store data with latitude and longitude to facilitate partners' secondary development.


Sychronized Information Update

Get the daily changed offer information of UnionPay international through the interface, and keep pace with the offer information of UnionPay International's official website.


When to Use it?

1) The cardholder inquires about the offer according to the specific merchant.

2) The cardholder queries the acquiring merchant according to the merchant offer type

3) According to the merchant's  data, the offer nearby will be secondary developed to facilitate UPI cardholders


Who Use it?
Acquirer, Issuers, Third-party App manufacturers
Where to Use it?
This API is available globally
Flow Chart
Flow Chart

数据调用类流程图.png

Access Flow:

1. API Caller apply to use APIs

2. UPI approve application, update white list and generate key pair, then provide API Caller the public key and user ID (appID)


Call Flow:

3. API Caller uses the public key to encrypt the request message which include caller’s user identity information

4. UPI verify API Caller’s identity, decrypt request message, and return response data encrypted by using private key.


API Reference
API Reference
  • Query of the active offer participating merchant list
  • Query of merchant details
  • Query of the active offer participating store list
  • Query of store details
  • Query of the offer list
  • Query of offer details
  • Notification on the list query result
Interface description
This operation allows a member institution to query UPI for the merchant list updated within a certain period of time. The returned result only contains the merchant information related to the offers available for the institution's offer list. UPI returns the result based on specific parameters in the request message.
Request Method
HTTP GET/POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Message information msgInfo Object M:Mandatory
Language lang ANS 1–5 M:Mandatory zh: Simplified Chinese en: English Default value: zh
Message ID msgId AN 17–49 M:Mandatory "M00001034 420171230235959000000" "M" is used to indicate this request is generated from a member institution's system.Components: "M"+INS ID+Serial Number The components of the response message are the same as those of the request message.
Timestamp timeStamp N 14 M:Mandatory "20170714235959" Beijing Time Format:YYYYMMDDhhmmss
Message type msgType ANS 15 M:Mandatory "" "ACTIVEOFFER_MERCHANT_LIST_QUERY"
Institution code insCode AN 8–11 M:Mandatory "200010344" Code of the member institution (assigned by the system)
Transaction information trxInfo Object None
Start time of merchant information update merchantUpdateFrom N 8 M:Mandatory By default, "20180101" indicates that the start time is 00:00.The time cannot be earlier than the last update date in the response message with the processing result that is successfully received. Start date (Beijing Time) of merchant information modification format: YYYYMMDD
End time of merchant information update merchantUpdateEnd N 8 M:Mandatory By default, "20180101" indicates that the end time is 24:00. End date (Beijing Time) of merchant information modification format: YYYYMMDD
Page number pageIndex N 1–4 M:Mandatory "1" Number of the page to be queried in a paging query. For example, to query the records on page 8 among a total of 15 pages of records, fill in 8. To query records from the start, fill in 1.
Number of records per page pageRows N 1–2 M:Mandatory "10" Number of records returned per page in a paging query
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message information msgInfo Object M:Mandatory
Language lang ANS 1–5 M:Mandatory zh: Simplified Chinese en: English Default value: zh
Message ID msgId AN 17–49 M:Mandatory "M00001034 420171230235959000000" "M" is used to indicate this request is generated from a member institution's system. Components: "M"+INS ID+Serial Number The components of the response message are the same as those of the request message.
Timestamp timeStamp N 14 M:Mandatory "20170714235959" Beijing Time format:YYYYMMDDhhmmss
Message type msgType ANS 15 M:Mandatory "" "ACTIVEOFFER_MERCHANT_LIST_QUERY"
Institution code insCode AN 8–11 M:Mandatory "200010344" Code of the member institution (assigned by the system)
Transaction information trxInfo Object None
Total records totalRows N 1–5 M:Mandatory Total number of records that meet the search criteria
Total pages totalIndex N 1–4 M:Mandatory Total number of pages
Data information dataList List M:Mandatory
Country or region code countryCode N 3 M:Mandatory Country where a merchant is headquartered
Merchant name merchantName S 1–64 M:Mandatory
Merchant ID merchantId ANS 1–15 M:Mandatory ID of the merchant
Merchant status status S 2 M:Mandatory 00: normal 04: invalid Status of the merchant
Merchant URL officialWebsite ANS 1–255 M:Mandatory Official website of the merchant
Message response msgResponse M:Mandatory
Response code responseCode AN 2 M:Mandatory "00" Response code
Response message responseMsg S 1–100 M:Mandatory "Approved" Response message
Steps to Launch
Steps to Launch

1) Fill in the business application form and submit it to the business department according to the offer type .

2)Simultaneously complete sandbox test and submit test results for review.

3) Transfer to production and go live after approval authority of business department


Please contact Developer operation team by submitting order.

  • Contact Us
  • If you have any further questions, please register and submit order in your user center.