Open API >Offers & Benefits >Merchants' offer
Merchants' offer
Offers & Benefits Developer Acquirer
Partners like Mafengwo/TripAdvisor,etc., can leverage detailed merchants' offer from UPI's website and connect to their channels. Note: This API will upgrade to a new version in 2020, new version will feature more detailed information, please stay tuned.
API Introduction
API Introduction
What is it?

Users like Mafengwo/TripAdvisor,etc., can leverage detailed merchants' offer from UPI's website and connected to their channels.

Who Use it?
Third party partners.
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
  • Get Merchant Offers (Country Information)
  • Get Merchant Offers (Merchant Category)
  • Get Merchant Offers (Applicable Card Types)
  • Inquire on Merchant Offers Using Parameters
Interface description
Leverage country data from UPI's merchant page.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Access to Application Identification appID string 128 M:Mandatory
Encryption Key appKey string 128 M:Mandatory
Language lang string 5 M:Mandatory
interface ID procType string 128 M:Mandatory getMerCountry
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Response Code respCode string 96 M:Mandatory
Response Message respMsg string 96 M:Mandatory
Country Name country string 100 M:Mandatory
Country ID countryId string 100 M:Mandatory
Sample code
Request code
Other
{
 "appId": "liuliangjigou",
 "appKey": "liuliangjigoukey",
 "fields": {
  "lang": "cn"
 },
 "procType": "getMerCountry"
}

Note: Request message plaintext shall be encrypted by using Key Store file in Sandbox Testing Parameters. The format of encrypted request message would be {"data":"XXXX","signature":"XXXX"}

Encrypted version of above message:
{"data":"eyJhcHBJZCI6ImxpdWxpYW5namlnb3UiLCJwcm9jVHlwZSI6ImdldE1lckNvdW50cnkiLCJmaWVs\r\nZHMiOnsibGFuZyI6ImNuIn0sImFwcEtleSI6ImxpdWxpYW5namlnb3VrZXkifQ==","signature":"RWhJNLF6FifMq9dv8PusrRb1QX8Ls05U8ikVwF+TfPgUSNAx6+8xBKFuRb33gSz5W7B3MdG4xJab\r\nYIa8Ng0qSNm4PQSaVQyAq2tmE1HkBpbfMW4FagzDKEcBIyfBxjWUEhyrtKcCsv/qKT/NE0TOwrUE\r\nDOXr0AWTlBY8D19loJQ="}


Response code
Other
{"data":[{"country":"阿尔巴尼亚","countryId":"1005026"},{"country":"阿尔及利亚","countryId":"1003027"},{"country":"阿富汗","countryId":"1006045"},{"country":"阿根廷","countryId":"1004017"},{"country":"阿拉丁","countryId":"1002026"},{"country":"阿联酋","countryId":"1006046"},{"country":"阿鲁巴","countryId":"1004025"},{"country":"阿曼","countryId":"1006047"},{"country":"埃及","countryId":"1003018"},{"country":"埃塞俄比亚","countryId":"1003009"},{"country":"爱尔兰","countryId":"1005021"},{"country":"澳大利亚","countryId":"1002012"},{"country":"比利时","countryId":"1005005"},{"country":"德国","countryId":"1005007"},{"country":"俄罗斯","countryId":"1005011"},{"country":"法国","countryId":"1005012"},{"country":"法属波利尼西亚","countryId":"1002017"},{"country":"菲律宾","countryId":"1006032"},{"country":"斐济","countryId":"1002016"},{"country":"芬兰","countryId":"1005009"},{"country":"哈萨克斯坦","countryId":"1006033"},{"country":"韩国","countryId":"1006034"},{"country":"荷兰","countryId":"1005018"},{"country":"加拿大","countryId":"1004018"},{"country":"柬埔寨","countryId":"1006009"},{"country":"卡塔尔","countryId":"1006025"},{"country":"肯尼亚","countryId":"1003025"},{"country":"老挝","countryId":"1006043"},{"country":"马尔代夫","countryId":"1006036"},{"country":"马来西亚","countryId":"1006037"},{"country":"毛里求斯","countryId":"1003031"},{"country":"美国","countryId":"1004035"},{"country":"蒙古","countryId":"1006016"},{"country":"缅甸","countryId":"1006018"},{"country":"摩纳哥","countryId":"1005041"},{"country":"南非","countryId":"1003033"},{"country":"日本","countryId":"1006015"},{"country":"瑞典","countryId":"1005038"},{"country":"瑞士","countryId":"1005042"},{"country":"塞舌尔","countryId":"1003056"},{"country":"斯里兰卡","countryId":"1006007"},{"country":"泰国","countryId":"1006011"},{"country":"土耳其","countryId":"1006048"},{"country":"西班牙","countryId":"1005031"},{"country":"新加坡","countryId":"1006001"},{"country":"新西兰","countryId":"1002024"},{"country":"意大利","countryId":"1005044"},{"country":"印度","countryId":"1006020"},{"country":"印度尼西亚","countryId":"1006019"},{"country":"英国","countryId":"1005043"},{"country":"越南","countryId":"1006024"},{"country":"中非共和国","countryId":"1003055"},{"country":"中国澳门","countryId":"1006041"},{"country":"中国大陆","countryId":"1006038"},{"country":"中国台湾","countryId":"1006039"},{"country":"中国香港","countryId":"1006040"},{"country":"","countryId":"1001"}],"respMsg":"success","respCode":"01"}


Response Code Reference
Response Code Reference
Response code Description
01 success
02 sys_error
03 service_stop
04 precess_timeout
05 signature error
06 Missing necessary parameters
07 Request parameter format error
08 Request parameter type error
09 other error illegal parameter
10 Query no record
10000 success
10001 sys_error
10002 service_stop
10003 precess_timeout
10004 signature error
20001 Missing necessary parameters
20002 Request parameter format error
20003 Request parameter type error
20004 other error
20005 illegal parameter
20006 Query no record
Steps to Launch
Steps to Launch

Interface Access Flow

1, The service provider releases the interface.

2, The caller raises access application.

3, The service provider approves the application.

4, The service provider updates the interface white list.

5, The service provider generates the key pair.

6, The service provider keeps the private key, and provides the api user the public key and user ID (appID). 


Interface Call Flow

1, The caller uses the public key to encrypt the request, while the request message should include caller's user identity information.

2, The service provider verifies the caller's user identity and the corresponding interface permissions.

3, The service provider decrypts the request message using the private key.

4, The service provider implements the interface function to obtain the return data.

5, The service provider uses private key to encrypt the return message.


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