U Rewards
Offers & Benefits Merchant Mobile Payment
UPI Benefit Rewards Platform (UBRP) provides the services of UnionPay cards’ benefits verification and writing off to the Merchant.
API Introduction
API Introduction
What is it?

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.


Key Features

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


When to Use it?

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.


Who Use it?
Merchant and Technical Service Provider
Where to Use it?
This API is available globally.
Flow Chart
Flow Chart

Benefits Verification & Writing-off

流程图1.png

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

流程图2.png

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.


API Reference
API Reference
  • Write off
  • Revoke
  • Result Inquiry
Interface description
UBRP generates the benefit code for Cardholder, and then Merchant verifies and writes off the benefit code via UBRP’s write-off API.
Request Method
HTTP POST
Request Parameter
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.
Synchronous Response parameters
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
Response Code responseCode AN 2 M:Mandatory It contains a code that defines the response to a request.
Response Message responseMsg S 1-100 M:Mandatory It contains the transaction result and the rejection reason if the transaction fails.
Error Details errorDetail S 1-255 O:Optional It contains additional detail regarding the problem identified in the message. The information is only for debug purpose. It shall not be displayed to the customer, cashier, etc.
Sequence Chart
Sequence Chart

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.jpg

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.

时序图2.jpg

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.


Security Requirement
Security Requirement

UnionPay International has adopted unified security requirement, please refer to UPI Server-based API General Requirements  for signature and encryption guide.

Steps to Launch
Steps to Launch

For Merchant, UPI Rewards Platform Application Form is required to fill in. Please contact local benefit team to proceed.

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