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
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.
Membership card binding: Through this service, industry partners ( coupons & reward points provoider ) 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 can use their reward points to redeem UnionPay coupons and enjoy instant discounts when shopping at merchants that accept UnionPay cards
Points exchange: Exchange points and coupons with other partners to fulfill the demand of cooperation among loyalty programs.
Flexible technical solution: Channel partners can choose to connect the platform via API, or via a full set of H5 solutions to simplify development
Multilingual support
It is applicable to partners that want to integrate UnionPay International Points Redemption Platform and provide membership card binding and points redemption service to their customers.
In some cases, the partner might play 2 roles(Channel Partner & Industry Partner), dual Role Partner plays as a Channel Partner role when providing an entry for users to bind and visit their membership cards and redeem coupons with other Industry Partner’s points; and plays as an Industry Partner role when letting users redeem coupons/points with Dual Role Partner’s own points.
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.
Coupon/Ponits 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.
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C”+ Channel 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | R:Returned | "C0001034420171230235959000023" | 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: “C”+ Channel 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 | R:Returned | The unique number assigned by the UPRP for the Industry Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner IIN | channelIIN | AN | 8-12 | R:Returned | The unique number assigned by the UPRP for the Channel Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner User ID | channelUserID | AN | 1-32 | R:Returned | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Membership Card Information | memberCardInfo | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Message Response | msgResponse | Object | M:Mandatory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C”+ Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | O:Optional | If there are two Industry Partners involved in the coupon redemption transaction, this field is used for the partner of points reduction. | ||||||||||||||||||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | M:Mandatory | If there are two Industry Partners involved in the coupon redemption transaction, this field is used for the partner of points increase. | ||||||||||||||||||
Channel Partner IIN | channelIIN | AN | 44055 | M:Mandatory | The unique number assigned by the UPRP for the Channel Partner. | ||||||||||||||||||
Channel Partner User ID | channelUserID | AN | 1-32 | M:Mandatory | |||||||||||||||||||
Membership Card Information 1 | memberCardInfo1 | Object | O:Optional | ||||||||||||||||||||
|
Membership Card Information 2 | memberCardInfo2 | Object | C:Conditional | Present when it is not the Uplan or Instant activity. | ||||||||||||||||||
|
Event ID | eventID | AN | 1-30 | C:Conditional | The identifier of the event. Either “eventID” or “increasePoints” shall be present. | |||||||||||||||||
Points Reduction Number | reductionPoints | N | 1-10 | M:Mandatory | |||||||||||||||||||
Points Increase Number | increasePoints | N | 1-10 | C:Conditional | Either “eventID” or “increasePoints” shall be present. | ||||||||||||||||||
Coupon Apply Elements | couponApplyElements | N | 2 | M:Mandatory | Valid value: 00 – No elements; 01 – PAN + Mobile number | ||||||||||||||||||
Encrypted Data | encData | ANS | C:Conditional | JWE |
|||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | R:Returned | "C0001034420171230235959000023" | 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: “C”+ Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Membership Card Information 1 | memberCardInfo1 | Object | O:Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Membership Card Information 2 | memberCardInfo2 | Object | C:Conditional | Present when it is not the Uplan or Instant activity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Information | couponInfo | Object | C:Conditional | If the coupon redemption is successful. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Status Inquiry Method | couponStatusInquiryMethod | N | 2 | C:Conditional | Valid value: 01 – Coupon status inquiry; 02 – Coupon status notification. Present if the coupon redemption is successful. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "U0001030020171230235959000023" | 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: “U”+ Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | O:Optional | If there are two Industry Partners involved in the coupon redemption transaction, this field is used for the partner of points reduction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | M:Mandatory | If there are two Industry Partners involved in the coupon redemption transaction, this field is used for the partner of points increase. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | C:Conditional | Present when it is the coupon redemption, not the points redemption. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Points Reduction Number | reductionPoints | N | 1-10 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Points Increase Number | increasePoints | N | 1-10 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Membership Card Information 1 | memberCardInfo1 | Object | O:Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Membership Card Information 2 | memberCardInfo2 | Object | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Information | couponInfo | Object | C:Conditional | Present when it is the coupon redemption, not the points redemption. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Status Inquiry Method | couponStatusInquiryMethod | N | 2 | M:Mandatory | Valid value:01 – Coupon status inquiry; 02 – Coupon status notification |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | R:Returned | "U0001030020171230235959000023" | 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: “U”+ Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C”/”U”/”D”+ Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | C:Conditional | If there are two Industry Partners involved in the transaction, this field is used for the partner of points deduction. Present when the points to be redeemed is not of the Channel Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | C:Conditional | If there are two Industry Partners involved in the transaction, this field is used for the partner of points increase. Not present in the exceptional transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||
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 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 29-33 | M:Mandatory | |||||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Coupon Information | couponInfo | Object | O:Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Membership Card Information | memberCardInfo | Object | C:Conditional | Present when it is the coupon redemption using the points of the Industry Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | R:Returned | "C0001034420171230235959000023" | 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: “C”/”U”/”D”+ Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | R:Returned | If there are two Industry Partners involved in the transaction, this field is used for the partner of points deduction. Present when the points to be redeemed is not of the Channel Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | R:Returned | If there are two Industry Partners involved in the transaction, this field is used for the partner of points increase. Not present in the exceptional transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner IIN | channelIIN | AN | 8-12 | R:Returned | The unique number assigned by the UPRP for the Channel Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner User ID | channelUserID | AN | 1-32 | R:Returned | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 29-33 | R:Returned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Membership Card Information | memberCardInfo | Object | R:Returned | Present when it is the coupon redemption using the points of the Industry Partner. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Message Response | msgResponse | Object | M:Mandatory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C”/”U”/”D”+ Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | C:Conditional | If there are two Industry Partners involved in the transaction, this field is used for the partner of points reduction. Present when the original message has Industry Partner IIN 1. | ||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | C:Conditional | If there are two Industry Partners involved in the transaction, this field is used for the partner of points increase. Present when the original message has Industry Partner IIN 2. | ||
Channel Partner IIN | channelIIN | AN | 8-12 | O:Optional | The unique number assigned by the UPRP for the Channel Partner. | ||
Channel Partner User ID | channelUserID | AN | 1-32 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||
Original Message ID | originalMsgID | AN | 29-33 | M:Mandatory |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | R:Returned | "C0001034420171230235959000023" | 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: “C”/”U”/”D”+ Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | R:Returned | If there are two Industry Partners involved in the transaction, this field is used for the partner of points reduction. Present when the original message has Industry Partner IIN 1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | R:Returned | If there are two Industry Partners involved in the transaction, this field is used for the partner of points increase. Present when the original message has Industry Partner IIN 2. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner IIN | channelIIN | AN | 8-12 | R:Returned | The unique number assigned by the UPRP for the Channel Partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Channel Partner User ID | channelUserID | AN | 1-32 | R:Returned | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 29-33 | R:Returned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | C:Conditional | Present when the inquired transaction result includes the coupon information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Coupon Information | couponInfo | Object | C:Conditional | Present when the inquired transaction result includes the coupon information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Membership Card Information 1 | memberCardInfo1 | Object | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Membership Card Information 2 | memberCardInfo2 | Object | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Original Response Code | originalMsgResponseCode | ANS | 1-20 | M:Mandatory | “98” | 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Original Response Message | originalResponseMessage | S | 1-100 | C:Conditional | "Timeout" | It shall be the “responseMessage" of the message inquired. Present if the value of "originalMsgResponseCode" is not "PENDING" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel 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 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||
Membership Card Number | memberCardNo | AN | 1-32 | O:Optional | |||
Event ID | eventID | AN | 1-30 | M:Mandatory |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel 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 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||
Membership Card Number | memberCardNo | AN | 1-32 | O:Optional | |||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | M:Mandatory | |||||||||||||||||||||||||||
Percentage of Remaining Coupon | remainCouponPercentage | ANS | 1-10 | M:Mandatory | The percentage of the remaining coupons. | ||||||||||||||||||||||||||
Total Number of Coupon | couponTotalNumber | N | 1-20 | O:Optional | |||||||||||||||||||||||||||
Number of Claimed Coupon | couponClaimedNumber | N | 1-20 | O:Optional | |||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel 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 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | M:Mandatory | The identifier of the event. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Coupon Information | couponInfo | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel 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 | O:Optional | The unique number assigned by the Channel Partner for the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | M:Mandatory | The identifier of the event. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Coupon Information | couponInfo | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Status | couponStatus | N | 2 | M:Mandatory | Valid value: 01 – Unused;02 – Deleted; 03 – Used;04 – Expired;05 – Frozen;06 – Other | |||||||||||||||||||||||||||||||||||||||||||||||||
Original Amount | originalAmount | ANS | 1-13 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Currency | transactionCurrency | N | 3 | O:Optional | A 3-digit numeric value, as defined by [ISO 4217]. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Discount Amount | discountAmount | ANS | 1-13 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Date | transactionDate | AN | 8 | O:Optional | Format:YYYYMMDD | ||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Time | transactionTime | AN | 6 | O:Optional | Format:hhmmss | ||||||||||||||||||||||||||||||||||||||||||||||||||
Entry IIN | entryIIN | AN | 8-12 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Country Code | transactionCountryCode | N | 3 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Country Name | transactionCountryName | ANS | 1-100 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant ID | merchantID | ANS | 1-15 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | merchantName | ANS | 1-50 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Location | merchantLocation | ANS | 1-50 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Masked PAN | maskedPAN | ANS | 1-19 | O:Optional | The masked PAN with the first 6 digits and last 4 digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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) | |||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Industry Partner IIN 1 | industryIIN1 | AN | 8-12 | O:Optional | If there are two Industry Partners involved in the transaction, this field is used for the partner of points reduction. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Membership Card Information 1 | memberCardInfo1 | Object | O:Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Industry Partner IIN 2 | industryIIN2 | AN | 8-12 | M:Mandatory | If there are two Industry Partners involved in the transaction, this field is used for the partner of points increase. | |||||||||||||||||||||||||||||||||||||||||||||||||
Event ID | eventID | AN | 1-30 | M:Mandatory | The identifier of the event. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Coupon Information | couponInfo | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coupon Status | couponStatus | N | 2 | M:Mandatory | Valid value: 01 – Unused;02 – Deleted;03 – Used;04 – Expired; 05 – Frozen;06 – Other | |||||||||||||||||||||||||||||||||||||||||||||||||
Original Amount | originalAmount | ANS | 1-13 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Currency | transactionCurrency | N | 3 | O:Optional | A 3-digit numeric value, as defined by [ISO 4217]. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Discount Amount | discountAmount | ANS | 1-13 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Date | transactionDate | AN | 8 | O:Optional | Format:YYYYMMDD | ||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Time | transactionTime | AN | 6 | O:Optional | Format:hhmmss | ||||||||||||||||||||||||||||||||||||||||||||||||||
Entry IIN | entryIIN | AN | 8-12 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Country Code | transactionCountryCode | N | 3 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Country Name | transactionCountryName | ANS | 1-100 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant ID | merchantID | ANS | 1-15 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | merchantName | ANS | 1-50 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Location | merchantLocation | ANS | 1-50 | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||
Masked PAN | maskedPAN | ANS | 1-19 | O:Optional | The masked PAN with the first 6 digits and last 4 digits. |
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 | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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. | |
App Id | appId | AN | 1-64 | M:Mandatory | |||
Secret | secret | AN | 1-64 | M:Mandatory | |||
Code | code | AN | 1-64 | M:Mandatory | |||
Grant Type | grantType | AN | 1-30 | M:Mandatory | Valid Value: "AUTHORIZATION_CODE" |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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. | |||||||||||||||||||||||||
Access Token | accessToken | AN | 1-255 | M:Mandatory | JWT |
||||||||||||||||||||||||||
Expires In | expiresIn | N | 1-10 | M:Mandatory | |||||||||||||||||||||||||||
User Id | userId | AN | 1-32 | M:Mandatory | |||||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |
Access Token | accessToken | AN | 1-255 | M:Mandatory | JWT |
||
User Id | userId | AN | 1-32 | M:Mandatory |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 29-33 | M:Mandatory | "C0001034420171230235959000023" | 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: “C” + Channel Partner IIN (8-12 digits)+ Transmission Year (YYYY)+ Transmission Date and Time (MMDDhhmmss) + Serial Code (6 numeric digits) | |||||||||||||||||||||||||
Channel Membership Level | channelMemberLevel | ANS | 1-50 | O:Optional | |||||||||||||||||||||||||||
Encrypted Data | encData | ANS | M:Mandatory | JWE |
|||||||||||||||||||||||||||
|
Message Response | msgResponse | Object | M:Mandatory | |||||||||||||||||||||||||||
|
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.
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.
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.
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.
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.
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.
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.
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.
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.
Channel partner refers to entity who provides a wallet for users to visit their membership card, exchange the points, and store the coupons. Channel partner shall fill in the UPI Points Redemption Platform Application Form.
Please submit order in support center to get assistance.