Open API >Offers & Benefits >UPI Points Redemption Platform For Industry Partner
UPI Points Redemption Platform For Industry Partner
Offers & Benefits Merchant Issuer Mobile Payment
UPI Point Redemption Platform provides the services of membership card binding, points redemption, and so on to industry partners like merchants.
API Introduction
API Introduction
What is it?

Membership and loyalty points systems are among the most effective ways to strengthen customer loyalty. However, pain points such as difficulties in getting popular merchants on board and the high costs of traffic channel partner still exist in such systems. UPI Point Redemption Platform provides the services of membership card binding, points redemption, and so on for both industry partners and channel partners like banks and merchants. By leveraging the platform as liaison, both partners can substantially lower the cost of technical integration while expanding the usage scope of their reward points. Besides strengthening loyalty programs, the platform is also a convenient way for channel partners to develop business cooperation with more popular merchants, while for industry partners it is a way to obtain more branding exposure and attract new customers.

Key Features

Membership card binding

Through this service, industry partners (merchants) can introduce membership registration and binding functions to the traffic channel apps of the platform, offering users an electronic membership card-using experience while introducing new members for the merchant. Furthermore, the service can satisfy the demands of membership collaboration among merchants

UnionPay coupon redemption

Users of partners can use their reward points to redeem UnionPay coupons and enjoy instant discounts when shopping at merchants that accept UnionPay cards

Points exchange

Partners can exchange points and coupons with other partners to fulfill the demand of cooperation among loyalty programs.

Flexible technical solution

Partners can choose to connect the platform via API,

or via a full set of H5 solutions to simplify development

Multilingual support


When to Use it?

This API is applicable to industry partner that want to integrate UnionPay International Points Redemption Platform  and provide membership card binding and points redemption service to their customers.

Who Use it?
Bank, Merchant and Technical Service Provider
Where to Use it?
This API is available globally.
Things to Know

Channel partner refers to the entity who provides a wallet for users to visit their membership card, exchange the points, and store the coupons.

Industry partner refers to entity who provides and maintains the service of industry membership card and points.

Industry partner shall fill in the UPI Points Redemption Platform Application Form.

Dual role partner who has functionalities of both Channel Partner and Industry Partner.


Flow Chart
Flow Chart

积分兑换流程-绑定会员卡.png

Membership Card Binding 

1. Cardholder opens channel APP

2. Jump to UPRP H5,and select a Industry membership card;

3. Jump to Industry H5, and register or login;

4. Industry backend system returns membership card info to UPRP;

5. UPRP transmits card info to channel partner to complete card binding.

积分兑换流程-积分兑换.png

Coupon/Points Redemption

1. Cardholder opens channel APP

2. After cardholder selects a coupon to be redeemed, the channel app deducts points and initiates coupon redemption transaction to UPRP;

3. UPRP initiate points increase transaction to Industry partner;

4. Industry partner returns redemption results to UPRP;

5. UPRP returns redemption results to channel partner.


API Reference
API Reference
  • MEMBERSHIP_CARD_INFO_NOTIFICATION
  • MEMBERSHIP_CARD_INFO_INQUIRY
  • POINTS_REDUCTION
  • POINTS_INCREASE
  • RETURN
  • TRX_RESULT_INQUIRY
  • COUPON_NUMBER_INQUIRY
  • COUPON_STATUS_INQUIRY
  • COUPON_STATUS_NOTIFICATION
Interface description
When the user enrollment is successful, the Industry Partner system sends the MEMBERSHIP_CARD_INFO_NOTIFICATION request message with the membership card information to UPRP. UPRP records the membership card information and returns the acknowledge response message to the Industry Partner system.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Message ID msgID AN 29-33 M:Mandatory "D0001034420171230235959000023" 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: “D”+ Industry Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits)
Industry Partner IIN industryIIN AN 8-12 M:Mandatory The unique number assigned by the UPRP for the Industry Partner.
Channel Partner IIN channelIIN AN 8-12 M:Mandatory The unique number assigned by the UPRP for the Channel Partner.
Channel Partner User ID channelUserID AN 1-32 M:Mandatory The unique number assigned by the Channel Partner for the user.
Membership Card Information memberCardInfo Object M:Mandatory
Membership Card Number memberCardNo AN 1-32 M:Mandatory
Membership Card Effective Date memberCardEffectDate AN 8 O:Optional The effective date of the membership card. Format: YYYYMMDD
Membership Card Expiry Date memberCardExpiryDate AN 8 O:Optional The expiry date of the membership card. Format: YYYYMMDD
Points Number pointNumber N 1-10 M:Mandatory The number of the points in the membership card.
Points Expiry Date pointsExpiryDate AN 8 O:Optional The expiry date of the points in the membership card. Format: YYYYMMDD
User Name userName ANS 30 O:Optional
Membership Card Status cardStatus AN 2 M:Mandatory Valid Values: 01 – normal; 02 – invalid
Card Face ID cardFaceID AN 1-20 C:Conditional The identifier of the membership card image. Present when the membership card is not of the Channel Partner.
Card Face Type cardFaceType N 1 O:Optional Valid Values: 0 – horizontal; 1 – vertical
Card Number Position X cardNoPosX N 3 O:Optional Position X of the membership card number in card layout, value from “0” to “999”.
Card Number Position Y cardNoPosY N 3 O:Optional Position Y of the membership card number in card layout, value from “0” to “999”.
Card Number Font Size cardNoFontSize N 3 O:Optional Font size of the membership card number in card layout, value from “0” to “100”.
Text Color textColor AN 12 O:Optional Color of the text layout of the membership card number in RRGGBB hexadecimal format.
Card Face Data cardFaceData AN 1-2048000 O:Optional Data of image in Base64 format.
Membership Card Level memberCardLevel AN 2 O:Optional
URL Information urlInfo Array O:Optional The URL information linked to the other contents related to the membership card.
URL Name urlName ANS 1-50 O:Optional The URL name.
URL url ANS 1-256 O:Optional The URL link.
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message ID msgID AN 29-33 M:Mandatory "D0001034420171230235959000023" 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: “D”+ Industry Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits)
Message Response msgResponse Object M:Mandatory
Response Code responseCode AN 2 M:Mandatory "98" It contains a code that defines the response to a request.
Response Message responseMsg S 1-100 M:Mandatory "Response timeout" It contains the transaction result and the rejection reason if the transaction fails.
Error Details errorDetail S 1-255 O:Optional “The Issuer response is time out.” 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

Membership Card Enrollment

When the Channel Partner’s APP user enrolls the industry membership card, the user opens the H5 page provided by UPRP and UPRP processes to jump to the industry membership card enrollment page.

After collecting the user enrollment information via H5 page on the Channel Partner’s APP, the Industry Partner conducts necessary checks and enrolls the user. If the enrollment is successful, the Industry Partner informs the user of the enrollment result via H5 page and sends the membership card information to UPRP then UPRP forwards the membership card information to the Channel Partner. If the enrollment is failed, the Industry Partner only returns the failure result to the user via H5 page. The flow of membership card enrollment is as follows.

4.2 Membership Card Enrollment.png

1.The user opens the INDUSTRY_CARD_LIST_URL connection on the Channel Partner’s APP.

2.UPRP displays the corresponding industry membership card list according to the request channel information.

3.The user chooses to enroll an industry membership card.

4.UPRP redirects the connection to the Industry Partner’s H5 page.

5.Industry Partner collects user’s information and conducts necessary checks.

6.Industry Partner redirects the result page to UPRP.

7.When the user enrollment is successful, the Industry Partner system sends the MEMBERSHIP_CARD_INFO_NOTIFICATION request message with the membership card information to UPRP.

8.UPRP records the membership card information and returns the acknowledge response message to the Industry Partner system.

9.UPRP forwards the membership card information to the Channel Partner system.

10.The Channel Partner system returns the acknowledge response message and records the membership card information for displaying use.

Exceptional flow:

1.When the Industry Partner system does not receive the response message from UPRP within 30 seconds, it can resend the MEMBERSHIP_CARD_INFO_NOTIFICATION request message.

2.When UPRP does not receive the response message from the Channel Partner system within 30 seconds, it can resend the MEMBERSHIP_CARD_INFO_NOTIFICATION request message.


Membership Card Binding

If the user already has a membership card of the Industry Partner, the user could bind the industry membership card to the Channel Partner’s APP.

When binding the industry membership card, the user opens the H5 page provided by UPRP and UPRP processes to jump to the industry membership card binding page. After collecting the required membership card information via H5 page, the Industry Partner conducts necessary checks and binds the industry membership card for the user. If the binding is successful, the Industry Partner informs the user of the binding result via H5 page and sends the membership card information to UPRP then UPRP forwards the membership card information to the Channel Partner. If the binding is failed, the Industry Partner returns the failure result to the user only via H5 page. The flow of membership card binding is as follows.

4.3Membership Card Binding.png

1.The user opens the INDUSTRY_CARD_LIST_URL connection on the Channel Partner’s APP.

2.UPRP displays the corresponding industry membership card list according to the request channel information.

3.The user chooses to bind an industry membership card.

4.UPRP redirects the connection to the Industry Partner’s H5 page.

5.Industry Partner collects user’s information and conducts necessary checks.

6.Industry Partner redirects the result page to UPRP.

7.When the membership card binding is successful, the Industry Partner system sends the MEMBERSHIP_CARD_INFO_NOTIFICATION request message with the membership card information to UPRP.

8.UPRP records the membership card information and returns the acknowledge response message to the Industry Partner system.

9.UPRP forwards the membership card information to the Channel Partner system.

10.The Channel Partner system returns the acknowledge response message and records the membership card information for displaying use.

Exceptional flow:

1.When the Industry Partner system does not receive the response message from UPRP within 30 seconds, it can resend the MEMBERSHIP_CARD_INFO_NOTIFICATION request message.

2.When UPRP does not receive the response message from the Channel Partner system within 30 seconds, it can resend the MEMBERSHIP_CARD_INFO_NOTIFICATION request message.


Membership Card Inquiry

When the user clicks on the industry membership card, which is already bound to the Channel Partner’s APP, the Channel Partner initiates a membership card inquiry transaction through UPRP to the Industry Partner and displays the membership card information after receiving the inquiry response message. The flow of membership card inquiry is as follows.

4.4Membership Card Inquiry.png

1.The Channel Partner system initiates the MEMBERSHIP_CARD_INFO_INQUIRY request message with the membership card number to UPRP.

2.UPRP forwards the inquiry request message to the Industry Partner system.

3.The Industry Partner system returns the membership card information to UPRP in the response message.

4.UPRP forwards the membership card information in the response message to the Channel Partner system for displaying.

Exceptional flow:

1.When the Channel Partner system does not receive the response message from UPRP within 30 seconds, it can resend the MEMBERSHIP_CARD_INFO_INQUIRY request message.

2.When UPRP does not receive the response message from the Industry Partner system within 10 seconds, it can resend the MEMBERSHIP_CARD_INFO_INQUIRY request message.


Coupon/Points Redemption_API

When the user uses the points of the Channel Partner to redeem a coupon or industry points on the Channel Partner’s APP, the Channel Partner shall firstly check if the points are sufficient or not, then initiate the coupon/points redemption transaction to UPRP. If the points to be redeemed is of the Industry Partner, the Channel Partner can directly initiate the coupon redemption transaction to UPRP. The flow of coupon/points redemption is as follows.

4.5CouponPoints Redemption_API.png

1.The Channel Partner system sends the COUPON_REDEMPTION request message to UPRP.

2.UPRP forwards the coupon redemption request to the corresponding coupon system and/or the Industry Partner system. After receiving the coupon redemption outcomes, UPRP returns the transaction result and the coupon information to the Channel Partner system in the COUPON_REDEMPTION response message.

Exceptional flow:

1.When the Channel Partner system does not receive the response message from UPRP within 30 seconds, it can initiate the TRX_RESULT_INQUIRY request message to UPRP, using the original Message ID of the Coupon_ Redemption request message to check the transaction status. UPRP responses to the Channel Partner system to indicate whether the coupon redemption transaction is approved, rejected or pending. 


Points Reduction 

When the user uses the points of the Industry Partner to redeem a coupon on the Channel Partner’s APP, UPRP initiates the POINTS_REDUCTION request message to the Industry Partner after receiving the coupon redemption request from the Channel Partner. The flow of points reduction is as follows.

4.7Points Reduction.png

1.UPRP sends the POINTS_REDUCTION request message to the Industry Partner system after receiving the coupon redemption request from the Channel Partner system.

2.The Industry Partner system checks if the user’s points balance is sufficient to be deducted. If yes, the Industry Partner system deducts the points and returns the successful result in the response message to UPRP. If not, the Industry Partner system responses to UPRP that the user’s points balance is insufficient.  

Exceptional flow:

1.When UPRP does not receive the response message from the Industry Partner system within 10 seconds, it can initiate the TRX_RESULT_INQUIRY request message to the Industry Partner system, using the original Message ID of the POINTS_REDUCTION request message to check the transaction status.


Return

The user can return the unused coupon and restore the points through the return transaction. The return transaction may be sent from the Channel Partner to UPRP, or from UPRP to the Industry Partner. The flow of return transaction is as follows.

4.9 return.png

1.The Originator initiates the RETURN request message to the Receiver using the original Message ID.

2.The Receiver returns the transaction outcomes in the response message to the Originator.

Exceptional flow:

1.When the Originator does not receive the response message from the Receiver within 30 seconds, it can initiate the TRX_RESULT_INQUIRY request message to the Receiver, using the original Message ID of the RETURN request message to check the transaction status.


Coupon Number Inquiry

The user can initiate the coupon number inquiry transaction on the Channel Partner’s APP to obtain the latest coupon information. The flow of coupon number inquiry is as follows.

4.10Coupon Number Inquiry.png

1.The Channel Partner system initiates the COUPON_NUMBER_INQUIRY request message to UPRP.

2.If the coupon is of the Industry Partner, UPRP forwards the COUPON_NUMBER_INQUIRY request message to the Industry Partner system.

3.The Industry Partner system returns the coupon number in the response message to UPRP.

4.UPRP returns the coupon number in the response message to the Channel Partner system.

Exceptional flow:

1.When the Channel Partner system does not receive the response message from UPRP within 30 seconds, it can resend the COUPON_NUMBER_INQUIRY request message.

2.When UPRP does not receive the response message from the Industry Partner system within 10 seconds, it can resend the COUPON_NUMBER_INQUIRY request message.


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.

For detailed guide and demo project, please turn to Documentation to download.


Steps to Launch
Steps to Launch

For Industry partner and dual role partner, UPI Points Redemption Platform Application Form is required to fill in. Please contacet Developer team in Support Center to proceed.



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