One-Stop Cross-Border Shopping — Shop the World
UnionPay Content & Service Platform (UCSP) for Channel Partner
UnionPay Content & Service Platform (UCSP) for Service Provider
UnionPay Transportation Solutions
UPI Benefit Rewards Platform provides a tool to reward benefit regarding cardholder's behavior and implement differentiated benefits for Channel Partner.
By leveraging the Platform as liaison, both Channel Partner and Benefit Provider (Merchant) can substantially lower the cost of technical integration while implementing the benefit service scope. Meanwhile, dynamic display of benefits based on cardholder's eligible cards and corresponding consumption performance can continuously incentive cardholder to increase the possibility of card usage.
UnionPay benefit redemption
Cardholders can use their UnionPay card to redeem UnionPay benefit through H5 and enjoy the services at global merchant.
Flexible technical solution
Merchant can choose to connect the platform via API, or via a full set of Webpage Portal solutions to simplify development.
Multilingual support
UBRP can only provide APIs for merchants. Please refer to the following API details description. If the issuer's app or software developers' app want to integrate "U rewards" H5 interface, please refer to 'UPI content & service platform for channal App'
Benefits Verification and Writing Off: UBRP generates the benefit code for Cardholder, and then Merchant verifies and writes off the benefit code.
Benefits Revoke: Due to wrong operation of Merchant or other reasons, Merchant can initiate a revoke transaction of benefit.
Benefit Result Inquiry: When the Merchant system does not receive the response message from UBRP, it can initiate the result-inquiry request message to UBRP to check the transaction status.
Benefits Verification & Writing-off
1. Cardholder clicks “U Rewards” in the Channel APP, and enters the “Benefits Wallet” to check the unused benefit vouchers, and then selects a benefit voucher and clicks “Use Benefit”.
2. H5 page requests the unique benefit code related to the benefit voucher from UBRP.
3. UBRP generates the benefit code and returns it to H5 page for displaying to the Cardholder, and cardholder provides the benefit code to the Merchant by scanning or manually inputting.
4. The Merchant system initiates the write-off request message to UBRP to verify and write off the benefit code.
5.After conducting necessary checks and writing off the benefit code, UBRP returns the transaction results to the Merchant system in the response message.
6.UBRP notifies the Cardholder of the result of benefit code verification and writing off via H5 page.
Benefits Revocation
1. Merchant can initiate a revoke request message to UBRP, using the original Message ID of the write-off request message to cancel the previous benefit code verification and writing off transaction.
2. After checking whether the transaction to be revoked is successfully verified and written off on the same day and not exceed 10 minutes, UBRP revokes that transaction and returns the revoke result to the Merchant system in the response message.
3. UBRP notifies the Cardholder of the revoke result via H5 page.
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request. Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||
Benefit Code | benefitCode | ANS | 8-30 | M:Mandatory | The recommended length of benefit code is 12 bytes. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request. Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||||||||||||||||||||||||||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||||||||||||||||||||||||||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||||||||||||||||||||||||||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||||||||||||||||||||||||||
Order ID | orderID | AN | 10-32 | M:Mandatory | It contains the ID of order which it is used to match a benefit code to its status. | ||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request.Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||
Original Message ID | originalMsgID | AN | 36 | M:Mandatory | The original message ID of the BENEFIT_VERI_WRITE_OFF request message to be voided. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request.Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||||||||||||||||||||||||||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||||||||||||||||||||||||||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||||||||||||||||||||||||||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||||||||||||||||||||||||||
Order ID | orderID | AN | 10-32 | M:Mandatory | It contains the ID of order which it is used to match a benefit code to its status. | ||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request. Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||
Original Message ID | originalMsgID | AN | 36 | M:Mandatory | The original message ID of the message inquired. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 33 | M:Mandatory | It is used to match a response to its request. The value must uniquely identify any message that the partner initiates on any day. The value in the response must match the value in the request. Components: “B”+ Industry IIN (12 numeric characters) + Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits). Note: Within Message ID, if the Industry IIN is less than 12 characters, then it should be right-justified and left padded with zeros. | ||||||||||||||||||||||||||
Merchant ID | merchantID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the Merchant that connects to UBRP. | ||||||||||||||||||||||||||
Store ID | storeID | N | 10 | M:Mandatory | The unique number assigned by the UBRP for the store that connects to UBRP. | ||||||||||||||||||||||||||
Industry IIN | industryIIN | N | 12 | M:Mandatory | The unique number assigned by the UBRP for the Industry that connects to UBRP. | ||||||||||||||||||||||||||
Original Response Code | originalMsgResponseCode | ANS | 1-20 | M:Mandatory | Valid Values: • “PENDING”; • Response Code, such as “00”; When the result of the message inquired is not available, the Message Status shall be “PENDING”. Otherwise, it shall be the “responseCode” of the original message inquired. | ||||||||||||||||||||||||||
Original Response Message | originalResponseMessage | S | 1-100 | None | It shall be the “responseMessage" of the message inquired. Present if the value of "originalMsgResponseCode" is not "PENDING" | ||||||||||||||||||||||||||
Order ID | orderID | AN | 10-32 | M:Mandatory | It contains the ID of order which it is used to match a benefit code to its status. | ||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
1. Benefits Verification and Writing Off
Scenario: UBRP generates the benefit code for Cardholder, and then Merchant verifies and writes off the benefit code via UBRP’s API.
The flow of benefits verification and writing off transaction is as follows.
1.Cardholder clicks “Benefits Platform” in the Channel APP.
2.Cardholder enters the benefits list displayed on the H5 page which is provided by UBRP.
3.Cardholder clicks and enters the “Benefits Wallet” to check the unused benefit vouchers, and then selects a benefit voucher and clicks “Use Benefit”.
4.H5 page requests the unique benefit code related to the benefit voucher from UBRP.
5.UBRP generates the benefit code and returns it to H5 page for displaying to the Cardholder.
6.Cardholder provides the benefit code to the Merchant by scanning or manually inputting.
7.The Merchant system initiates the write-off request message to UBRP to verify and write off the benefit code.
8.After conducting necessary checks and writing off the benefit code, UBRP returns the transaction results to the Merchant system in the response message.
9.UBRP notifies the Cardholder of the result of benefit code verification and writing off via H5 page.
If the result of benefit code verification and writing off is successful, Merchant provides the benefit to the Cardholder. Otherwise, the Cardholder can feedback according to the usual process via 95516, high-end concierge hotline, or merchant customer service.
Exceptional flow:
When the Merchant system does not receive the response message from UBRP within 30 seconds, it can initiate the result-inquiry request message to UBRP, using the original Message ID of the write-off request message to check the transaction status.
2. Revoke
Scenario: Due to wrong operation of Merchant or other reasons, Merchant can initiate a void transaction. Note that the transaction to be voided shall be successfully verified and written off on the same day and not exceed 10 minutes.
The flow of void transaction is as follows.
1.Merchant can initiate a revoke request message to UBRP, using the original Message ID of the write-off request message to cancel the previous benefit code verification and writing off transaction.
2.After checking whether the transaction to be revoked is successfully verified and written off on the same day and not exceed 10 minutes, UBRP revokes that transaction and returns the revoke result to the Merchant system in the response message.
3.UBRP notifies the Cardholder of the revoke result via H5 page.
Exceptional flow:
When the Merchant system does not receive the response message from UBRP within 30 seconds, it can initiate the result-inquiry request message to UBRP, using the original Message ID of the revoke request message to check the transaction status.
UnionPay International has adopted unified security requirement, please refer to UPI Server-based API General Requirements for signature and encryption guide.
For Merchant, UPI Rewards Platform Application Form is required to fill in. Please contact local benefit team to proceed.