Open API >Data Service >u•plan
u•plan
Data Service Developer Acquirer Mobile Payment
U•plan is used by developers to deal with coupon. After browsing promotion from u•plan partners’ websites, Apps or WeChat Official Accounts, App users and UnionPay cardholders can access the coupons to participate in promotions.
API Introduction
API Introduction
What is it?

U•plan is the first cross-border marketing platform developed by UnionPay with purpose of mobile and web-based precision marketing by offering instant discounts. It utilizes cross-sectoral resources, upgrades service for all u•plan partner, and provides UnionPay cardholders with a new shopping experience. U•plan partners access u•plan platform through standard API, which helps participants retrieve real-time data. For example, when a cardholder requests a coupon in an App, the App will send request to u•plan platform and retrieve coupon code through API. 


Key Features

Precision marketing, instant discounts, and mobile / web-based marketing are its key features. The implementation of a u•plan process is based on mobile device. The most important feature of u•plan is being able to instantly reach our cardholders with needed information. For example, in an online travel agency (OTA) distribution channel, the OTA will inform its users about all the merchant activities at his/her destinations together with the flight order, hotel order or other orders related to his travelling. Mobile-based distribution is another important feature of u•plan. Cardholder receives activity notifications through mobile, then choose and save coupons in his/her mobile phone device for cashier to scan. After successful coupon verification, cardholder can enjoy the discount conveniently.


When to Use it?

U•plan participants may refer to the API introduction for 3 reasons:

1. Business Evaluation: make the dicision on whether to join uplan or not

2. System Modification Evaluation

3. Coding: get the example coding cases


Who Use it?
The system developers of the application provider and UnionPay International, and system testing and business acceptance personnel.
Where to Use it?
This API is available globally except for mainland China
Things to Know

Refer to Section V in the Instruction of the Interface for Application Providers of Cross-border Marketing Platform v1.0.3.docx.

 Security of Network Communication field.


Flow Chart
Flow Chart

uplan.jpg


UPI02.png

1.Traffic Portal: Institutions own customer resources and are willing to distribute u•plan activity coupons to its customers. Issuers and online travel agents (OTAs) are typical traffic portals.

2. Cardholders: Specifically referred to UnionPay cardholders.

3. Acquirer: Provide u•plan acceptance services to merchants.

4. Merchant: Store owners who provide u•plan coupons to attract consumers.


API Document
API Document
  • Members Acquire Coupons
  • Members Delete Coupons
  • Coupon Information Update
  • Coupon Verification Notice
  • Inquiry of The Num of Coup Used
  • Coupon Cancellation Notice
Interface description
After the members (including bank cardholders) of the application provider have browsed the detailed information of the promotion through the institution’s website, APP or WeChat Official Account, they can select to acquire the coupon to participate. In the same time, the system of the application provider will apply for acquiring the coupon to the cross border marketing platform, and display the handling result to the member in real time.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Reference number refNum N 12 M-Must The system of traffic inlet organizations generates random number or reference serial number, with response message returned as is; If a repetitive system reference number is sent in the same activity, the system will return the first successful coupon code
Encryption certificate ID encCertId AN 128 O-Optional Encryption certificate ID
Type of Operation procType AN 1 M-Must 1 - acquire a coupon.
Signature Certificate ID signCertId AN 128 M-Must
System Reference Number refNum N 12 M-Must The random number generated by the system of the application provider or reference serial number of the system.
Encryption Certificate ID encCertId AN 128 O-Optional
Display Language language AN 5 M-Must zh-cn: Simplified Chinese ; en: English.
Application Provider Institution Code insCode ANS 11 M-Must Application provider Code configured in the marketing platform.
Code of Promotion pmtCode ANS 30 M-Must Code of promotion configured in the marketing platform.
Mark of Card Number cardFlag N 1 M-Must 0 - not provide any card number; 1 - provide the full card number; 2 - provide the card number shielded.
Card Number cardList ANS 1024 O-Optional List of card numbers, which is transferred in encryption.
Surname of Cardholder lastName ANS 50 O-Optional
Name of Cardholder firstName ANS 50 O-Optional
Mobile Number mobile ANS 30 O-Optional Format : + Country code - mobile number.
Email Address email ANS 100 O-Optional
ID of Application Provider s APP walletId AN 11 O-Optional Used to represent the ID of the application provider’s APP.
User ID of Application Provider appUserId ANS 64 O-Optional Hash value of user ID.
Date and Time of Operation procDt ANS 14 M-Must Format : YYYYMMDDHHMISS.
Reserved Field resvFld ANS 500 O-Optional
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Type of Operation procType AN 1 M-Must 1 - acquire a coupon.
Signature Certificate ID signCertId AN 128 M-Must
Display Language language AN 5 M-Must zh-cn: Simplified Chinese ; en: English.
System Reference Number refNum N 12 M-Must Return as it is.
Response Code respCode ANS 2 M-Must Response code, as specifically defined in the response code reference
Response Message respMsg ANS 200 O-Optional
Coupon Code couponId ANS 19 C-Condition Mandatory when respCode is 00; uniform coupon business, it’s a fixed value.
Coupon Valid Start Date validStartDate N 8 C-Condition Mandatory when respCode is 00.
Valid Expiration Date of Coupon validEndDate N 8 C-Condition Mandatory when respCode is 00.
Reserved Field resvFld ANS 500 O-Optional
Sample code
Request code
Other
"data":"{"appUserId":"",
"cardFlag":"0",
"cardList":"",
"email":"",
"encCertId":"888",
"firstName":"",
"insCode":"000520000",
"language":"zh-cn",
"lastName":"",
"mobile":"+86-13511112222",
"pmtCode":"160603100020",
"procDt":"20180502142036",
"procType":"1",
"refNum":"05021420036",
"resvFld":"710584000001",
"signCertId":"888",
"walletId":""
}",
"signature":"iwXMK+ECphM6qiN1Vz+uF5XjdxlVlOmFMGdFHwWlULF1VsVVXxJ1O/JlFTmaAYCYw74p9/Bfvsg3iDPWMi33K5/Wgz244T2CYK6gor8ntFNJ1lySVq0GKjWMBf7dAX/QQyZXxmNfFFJwiFVSYSm05XqzULU7THXJ753tcoThdbwV0fFXWJpqRFoERbmGerWehAO5mqbL6WuFCOsOvQIQZD6r8GkOpMunAMUllWykrUIyfHtAHm7crEgO6UqIM6wVMHVOPchStAkZr2JeYQCvN8gZ9QZbgzeFuhDr85R8LyKwWIFRitNwEp4IM4oBkBD1=="


Response code
Other
"data":"{"respCode":"00",
"signCertId":"888",
"validEndDate":"20180531",
"resvFld":"",
"respMsg":"Success",
"refNum":"05021420036",
"validStartDate":"20180502",
"language":"zh-cn",
"couponId":"961912148721812417",
"procType":"1"
}",
"signature":"iwXMK+ECphM6qiN1Vz+uF5XjdxlVlOmFMGdFHwWlULF1VsVVXxJ1O/JlFTmaAYCYw74p9/Bfvsg3iDPWMi33K5/Wgz244T2CYK6gor8ntFNJ1lySVq0GKjWMBf7dAX/QQyZXxmNfFFJwiFVSYSm05XqzULU7THXJ753tcoThdbwV0fFXWJpqRFoERbmGerWehAO5mqbL6WuFCOsOvQIQZD6r8GkOpMunAMUllWykrUIyfHtAHm7crEgO6UqIM6wVMHVOPchStAkZr2JeYQCvN8gZ9QZbgzeFuhDr85R8LyKwWIFRitNwEp4IM4oBkBD="
//This sample code is for reference only,  "data" field should be encoded to Base64 format


Response Code Reference
Response Code Reference
Response code Description
00 success
01 format_error
02 xx field_format_error
03 xx field is missing
04 signature error
05 system reject
06 promotion not exists
07 promotion was over
08 coupon not exists
09 coupon was used up
10 coupon has been used
Steps to Launch
Steps to Launch

Step 1: Sign NDA

Step 2: Get U•plan Specification

Step 3: Business Negotiation

Step 4: Sign U•plan Cooperation Contract

Step 5: System Update

Step 6: Production Test

Step 7: Business Launch


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