By continuing your navigation on our website, you consent to the use of cookies to provide you with better services. To learn more, read our cookies policy.
x
APIs
Products & Solutions
Partner
Support
Sign in
Search
International
中国站
Open API >Offers & Benefits >U Collection-Premium Cardholder's Privileges
U Collection-Premium Cardholder's Privileges
Offers & Benefits Merchant Issuer Mobile Payment
U Collection platform contains a series of luxury global privileges handpicked by UnionPay for Platinum and Diamond cardholders, including Dining, Shopping, Hotel, Lifestyle, Travel and other top picks. 200 top merchants covering in more than 20 countries and regions are selected to prepare experiences full of glamour. Note: This API will upgrade to a new version in 2020, new version will feature more detailed information, please stay tuned.
Sandbox Testing
API Introduction
API Introduction
What is it?

U Collection platform contains a series of luxury global privileges and benefits including Dining, Shopping, Hotel, Lifestyle, Travel and other top picks. 

Through the API interface, users can obtain specific offer details on the U Collection platform to publish and display according to your own requirements

Key Features

High-end: Select merchants of high-end brands

Global: Cover over 20 countries and regions

High-quality: Provide attractive benefits to premium cardholders

When to Use it?

Users can use this API in following scenarios: 

1. When users want to change some of the details in U Collection platform to match the structure or design of their own channels(like App, website, and so on)

2. When users want to select some of the privileges to add value to their own platforms.

Who Use it?
Issuer, Traffic entrance and 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
  • Obtain cardholder benefits (category)
  • Obtain cardholder benefits (country)
  • Obtain cardholder benefits (city)
  • Search cardholder benefits by criteria
  • Obtain cardholder benefits (detail)
Interface description
Obtain cardholders' rights classification structure.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Access to Application Identification appID string 128 M:Mandatory
Access to Application Key appKey string 128 M:Mandatory
Thematic ID thematic_id string 96 M:Mandatory Privilege's theme ID
Node ID node_id string 96 O:Optional Privilege's ID. If null, will return all privileges
Interface ID procType string 128 M:Mandatory queryNode
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
Thematic ID thematic_id string 96 M:Mandatory
Node ID node_id string 96 M:Mandatory
Node Name node_name string 100 M:Mandatory
Node Grade node_grade int 10 M:Mandatory
Node Type node_type int 10 M:Mandatory 0：null；1：merchants and offers；2：banner；3：article。
Reserved Field resvFld string 300 O:Optional Alternative field
Sample code
Request code
Other 
{
 "appId": "ucollection_dining",
 "appKey": "ucollection_diningkey",
 "procType": "queryNode",
 "fields": {
  "thematic_id": "ff8080815caa4d70015cf84991180073",
  "node_id": "ff8080815caa4d70015cf84b89160076"
 }
}

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":"eyJhcHBJZCI6InVjb2xsZWN0aW9uX2RpbmluZyIsInByb2NUeXBlIjoicXVlcnlOb2RlIiwiZmll\r\nbGRzIjp7InRoZW1hdGljX2lkIjoiZmY4MDgwODE1Y2FhNGQ3MDAxNWNmODQ5OTExODAwNzMiLCJu\r\nb2RlX2lkIjoiZmY4MDgwODE1Y2FhNGQ3MDAxNWNmODRiODkxNjAwNzYifSwiYXBwS2V5IjoidWNv\r\nbGxlY3Rpb25fZGluaW5na2V5In0=","signature":"LBrAC4XT2Q7sWRCSqegZ3mKdK44qj/LpJiRLMxjAlcM1jruGXKNkCCmZAfqEWkjHCMXVyFfKdq/u\r\nAq1gYer758nR2uxhTJr2/1KVKdf+4Rw8eTgaqFxNB17lAtB2aAEASpARuRnwmgQuE0uZaUA2k6i/\r\nDuPk7EFGoA6WGxnA+Iw="}


Response code
Other 
{
 "respCode":"01",
 "respMsg":"success",
 "data":[{
  "node_id":"ff8080815caa4d70015cf84991180222",
  "thematic_id":"ff8080815caa4d70015cf84991180333",
  "node_name":"米其林名厨",
  "node_grade":1,
  "node_type":0,
  "resvFld":"" 
 }]
}


Steps to Launch
Steps to Launch

Interface Access Flow

1. The service provider releases the interface.

2. The caller applies for access.

3. The service provider approves the application and updates the interface white list.

4. The service provider generates the key pair.

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

Interface Call Flow

1. The caller uses the public key to encrypt the request message, which 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.
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
  • Contact Us
  • If you have any further questions, please register and submit order in your user center.
©Copyright 2002 - 2022. All rights reserved