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
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.
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.
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
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.
1. UPI offer coupon to agency by API
2. Cardholder obtain coupon from Agency through app or portal
3. Cardholder redeem coupon in specific merchant shop
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 1- Obtaining coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Encryption certificate ID | encCertId | AN | 1-128 | O:Optional | Encryption certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese. en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | The random number or reference number generated by traffic portal. It is returned in response message as is. | ||
Traffic portal ID | insCode | ANS | 1-11 | M:Mandatory | Traffic portal ID configured in the Marketing Platform | ||
Promotion campaign code | pmtCode | ANS | 1-30 | M:Mandatory | Promotion campaign code configured in the Marketing Platform. | ||
Mark of card number | cardFlag | N | 1 | M:Mandatory | 0: not provide any card number; 1: provide the full card number; | ||
Card number | cardList | ANS | 1-1024 | O:Optional | List of card numbers, which is transferred in encryption; 2: provide the card number shielded. At most 20 cards of the same user can share a coupon. Vertical line (|) is used as separator between card numbers. Asterisk (*) is used for the truncated digits of card number, and the truncated digits are equal to the actual digits of card number. E.g., 621222******4321|622333*********1234 | ||
Surname of Cardholder | lastName | ANS | 1-50 | O:Optional | |||
Name of Cardholder | firstName | ANS | 1-50 | O:Optional | |||
Mobile number | mobile | ANS | 1-30 | O:Optional | Format: +country code-Mobile number | ||
Email address | ANS | 1-100 | O:Optional | ||||
ID of application provider’s APP | walletId | AN | 1-11 | O:Optional | The ID of application provider’s APP. | ||
User ID of application provider | appUserId | ANS | 1-64 | O:Optional | It is the hash value of the login account ID information on smart device which is to identify the user. As the replacement value of the login account ID, it corresponds to the user's login account ID one by one. | ||
Date and time of operation | procDt | ANS | 14 | M:Mandatory | Format: YYYYMMDDHHMMSS | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 1- Obtaining coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese | ||
Reference number | refNum | N | 1-20 | M:Mandatory | Return the same value filled in the request message. | ||
Response code | respCode | ANS | 2 | M:Mandatory | Response code, see Appendix for details. | ||
Response message | respMsg | ANS | 1-200 | O:Optional | Response message, see Appendix for details. | ||
Coupon ID | couponId | ANS | 1-30 | O:Optional | The coupon ID. It must be filled in when respCode is 00. For the unified coupon campaign, the coupon ID is a fixed value during the campaign. | ||
Coupon valid start date | validStartDate | N | 8 | O:Optional | Must be filled in when respCode is 00. Format: YYYYMMDD | ||
Valid expiration date of coupon | validEndDate | N | 8 | O:Optional | Must be filled in when respCode is 00. Format: YYYYMMDD | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
"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=="
"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
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 2- Deleting coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Encryption certificate ID | encCertId | AN | 1-128 | O:Optional | Encryption certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | The random number or reference number generated by traffic portal. It is returned in response message as is. | ||
Traffic portal ID | insCode | ANS | 1-11 | M:Mandatory | Traffic portal ID configured in the Marketing Platform | ||
Promotion campaign code | pmtCode | ANS | 30 | M:Mandatory | Promotion campaign code configured in the Marketing Platform. | ||
Coupon ID | couponId | ANS | 1-30 | M:Mandatory | The coupon ID. | ||
Date and time of operation | procDt | ANS | 14 | M:Mandatory | Format: YYYYMMDDHHMISS | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 2- Deleting coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | Return the same value filled in the request message. | ||
Response code | respCode | ANS | 2 | M:Mandatory | Response code, see Appendix for details. | ||
Response message | respMsg | ANS | 1-200 | O:Optional | Response message, see Appendix for details. | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
"data":"{"couponId":"961912148721812417", "encCertId":"888", "insCode":"000520000", "language":"zh-cn", "pmtCode":"160603100020", "procDt":"20180502145152", "procType":"2", "refNum":"05021451052", "resvFld":"710584000001", "signCertId":"888" }","signature":"ca822IFILTGtwq2zpvs5ZH3MVBKIKYecuNcm4OcSv1KvTuV+74MTu7GF0wkxEMFq4gCfhT5ucmq0D7YFqYaQiiEQJy2lRcCWoiPXI6f7B2mUIUxABLNcSvpSRwvssQWOwHHWpZ+TJ+kyq4ZqTqeNdM3QKJmZtX5VvNan9cXPvZV3/OtNkkiWnGNxQx1km8vy7rSN5K0qvsjAmiAO1PDtxv3f4CVDHhBDEncGRbSRvfWfXrLvR1i/DJxiWcDyG86p/AYnFEQSrA6zZgAWNLWlU9MUzJFlnRuB2Cz5rC/JwlxVr06ojoGQ=="
"data":"{"language":"zh-cn", "procType":"2", "refNum":"05021451052", "respCode":"00", "respMsg":"Success", "resvFld":"", "signCertId":"" }","signature":"VZLqU32QG6YLo9JvGKMAFJH90ifEG33vbGMF/1+DR8gPO9xVeoL+pmMzGi8YLE9WhDSdkUVIMvebcH9Erg++41bSpB1cQpbGRMpqh3oROeAKdPaQxesrcZ6UH7kaZibtW0DoZwvYX+rhTbuSjOz3PxHrX8inlQVON9WrDT+54FhMFaGUqGltRowaVQWZCCWtdyawXFwyLIuC58GKddGShZnAEaxBV0ijFaVoWKgvs3mP5Ro900obCGfHg8ZQHUUZBtIAKN/g8hKLOORHFbV707obFTdr3Ydy2DqZVO5R0geLZc6LzfUS0g==" //This sample code is for reference only, "data" field should be encoded to Base64 format
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 3- Updating coupon information | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Encryption certificate ID | encCertId | AN | 1-128 | O:Optional | Encryption certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | The random number or reference number generated by traffic portal. It is returned in response message as is. | ||
Traffic portal ID | insCode | ANS | 1-11 | M:Mandatory | Traffic portal ID configured in the Marketing Platform | ||
Promotion campaign code | pmtCode | ANS | 1-30 | M:Mandatory | Promotion campaign code configured in the Marketing Platform. | ||
Coupon ID | couponId | ANS | 1-30 | M:Mandatory | The coupon ID. | ||
Mark of card number | cardFlag | N | 1 | M:Mandatory | 0: not provide any card number; 1: provide the full card number; 2: provide the card number shielded | ||
Card number | cardList | ANS | 1-1024 | O:Optional | List of card numbers, which is transferred in encryption. At most 20 cards of the same user can share a coupon. Vertical line (|) is used as separator between card numbers. Asterisk (*) is used for the truncated digits of card number, and the truncated digits are equal to the actual digits of card number. E.g., 621222******4321|622333*********1234 | ||
Surname of Cardholder | lastName | ANS | 1-50 | O:Optional | |||
Name of Cardholder | firstName | ANS | 1-50 | O:Optional | |||
Mobile number | mobile | ANS | 1-30 | O:Optional | Format: +country code-Mobile number; E.g., +86-13511112222 | ||
Email address | ANS | 1-100 | O:Optional | ||||
The updating flag for the coupon effective date | couponUpdateFlag | A | 1 | M:Mandatory | 0: Not update the effective date; 1: Update the effective date | ||
Date and time of operation | procDt | ANS | 14 | M:Mandatory | Format: YYYYMMDDHHMISS | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 3- Updating coupon information | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | Return the same value filled in the request message. | ||
Response code | respCode | ANS | 2 | M:Mandatory | Response code, see response code reference for details. | ||
Response message | respMsg | ANS | 1-200 | O:Optional | Response message, see response coder reference for details. | ||
Coupon valid start date | validStartDate | N | 8 | O:Optional | It must be filled in when respCode is 00 and couponUpdateFlag in request message is 1. Format: YYYYMMDD | ||
Valid expiration date of coupon | validEndDate | N | 8 | O:Optional | It must be filled in when respCode is 00 and couponUpdateFlag in request message is 1. Format: YYYYMMDD | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional | |||
Type of Operation | procType | AN | 1 | M:Mandatory | 3 - Coupon information update. | ||
Signature Certificate ID | signCertId | AN | 128 | M:Mandatory | |||
Display Language | language | AN | 5 | M:Mandatory | zh-cn: Simplified Chinese ; en: English. | ||
System Reference Number | refNum | N | 12 | M:Mandatory | Return as it is. | ||
Response Code | respCode | ANS | 2 | M:Mandatory | Response code, as specifically defined in the response code reference | ||
Response Message | respMsg | ANS | 200 | O:Optional | |||
Valid Expiration Date of Coupon | validStartDate | N | 8 | C:Conditional | Mandatory when respCode is 00. | ||
Coupon Valid Start Date | validEndDate | N | 8 | C:Conditional | Mandatory when respCode is 00. | ||
Reserved Field | resvFld | ANS | 500 | O:Optional |
"data":"{"cardFlag":"0", "cardList":"", "couponId":"461962608471882670", "couponUpdateFlag":"0", "email":"", "encCertId":"888", "firstName":"", "insCode":"000520000", "language":"zh-cn", "lastName":"", "mobile":"+86-13511112222", "pmtCode":"160603100020", "procDt":"20180502145152", "procType":"3", "refNum":"05021451052", "resvFld":"710584000001", "signCertId":"888" }","signature":"MeDy7uOC/DN0n4u1z4kP/RRbHYK6prTSh+xMvXsL/YWlnpqUqOiDZ2nZeQVIneINCjjZgS88tqJtREFOi9Rzhw/ifqkCWKsXTtLg9MXtuSYlKohBHKkAxFBJCvVSyDSIiMr6kKiQrHZYuL2JnWH6Y+kT7n0wQ7tJ0+flcSEqRqCUuwagvc0B5efB5MA5HRERr/hAg4If3YZjEYanMQNeoTLxbwEL3XhzrBe3zZ7V6hUYIJYhII3ItKypy+N0QvXyPtkRLJIriOHiFr1wB0nx935KMY/ufld92/bD8JOU+nhwHrRe8S9aog1aURmeQ=="
"data":"{"language":"zh-cn", "procType":"3", "refNum":"05021451052", "respCode":"00", "respMsg":"Success", "resvFld":"", "signCertId":"", "validEndDate":"20180531", "validStartDate":"20180502" }","signature":"FqvKCfUmU8SyHOfSMROVCMeQ20yerKGgf7fg4J9J7D2ZFYCpazujoXBpZh79Ig6HEuylE8VndnAiWIZjlv2gZwqwWTr4g3XnAivMbrONj/QYkLkrWM443T9EK6amIW5lnjhQR3r9U2zJnGSD0LL8UgNjabZOm6bNns3n3Fdmc/1THUxTi9uWKNfBvVMKtgfMohzGywTOHKL8O5SBkjhzu7sspPCu9Y9cEb+2xzHd2PfcD/ywUB6pbQA1S/lL8M8FOxqhUzl40YVq4THU9rN/dI1bmkEBUpD6o3jhDPDw8Ajmi0Usg==" //This sample code is for reference only, "data" field should be encoded to Base64 format
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 4 - Push of coupon use. | ||
Signature Certificate ID | signCertId | AN | 128 | M:Mandatory | |||
Encryption Certificate ID | encCertId | AN | 128 | O:Optional | |||
Display Language | language | AN | 5 | M:Mandatory | zh-cn: Simplified Chinese ; en: English. | ||
System Reference Number | refNum | N | 12 | M:Mandatory | The random number generated by the system of the application provider or reference serial number of the system. | ||
Application Provider Institution Code | insCode | ANS | 11 | M:Mandatory | Application provider ,Code configured in the marketing platform. | ||
Code of Promotion | pmtCode | ANS | 30 | M:Mandatory | Code of promotion configured in the marketing platform. | ||
Coupon Code | couponId | ANS | 19 | M:Mandatory | |||
Transaction Location Country and Region Code | countryCode | N | 4 | O:Optional | Country code, such as 0344 indicates Hong Kong area. | ||
Name of Transaction Country and Region | countryName | ANS | 100 | O:Optional | Country code, such as 0344 indicates Hong Kong area. | ||
Transaction Currency | txnCurrCode | N | 3 | M:Mandatory | Currency code, such as 344 indicates Hong Kong dollar. | ||
Transaction Amount | txnAmt | ANS | 15 | M:Mandatory | Amount before discounting, with decimal places. | ||
Discount Amount | discountAmt | ANS | 15 | M:Mandatory | Discount amount, with decimal places. | ||
Merchant Code | merCode | ANS | 15 | O:Optional | |||
Merchant Name | merName | ANS | 40 | O:Optional | |||
Merchant Location | merLocation | ANS | 60 | O:Optional | For example: N22°32′37.05E114°03′46.56 | ||
Reserved Field | resvFld | ANS | 500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 4 - Push of coupon use. | ||
Signature Certificate ID | signCertId | AN | 128 | M:Mandatory | |||
Display Language | language | AN | 5 | M:Mandatory | zh-cn: Simplified Chinese ; en: English. | ||
System Reference Number | refNum | N | 12 | M:Mandatory | Return as it is. | ||
Response Code | respCode | ANS | 2 | M:Mandatory | Response code, as specifically defined in the response code reference | ||
Response Message | respCode | ANS | 200 | O:Optional | |||
Reserved Field | resvFld | ANS | 500 | O:Optional |
"data":"{"countryCode":"344", "countryName":"Hong Kong", "couponId":"931920868441090605", "discountAmt":"30.000", "encCertId":"899", "insCode":"200040156", "language":"en", "merCode":"701034453110010", "merLocation":"", "merName":"莎莎化粧品有限公司", "pmtCode":"180329100712", "procType":"4", "refNum":"76207490", "resvFld":"", "signCertId":"888", "txnAmt":"100.000", "txnCurrCode":"344" }","signature":"sTnwClypg05cR8vNAOeV6pe25ODrGZ1Azv2wUAYXUnq8Sg8hYaj3NprS%2BJKJ6ggLgDBmkSPvL%2B9rUVq2stHVUE7xIjVt0ZUgjKx7mibIy88qTHKTE1fIPZY8cS0yxTDed7wsA2pC2LQAWtmh%2BKGNzbTMs%2BDqIYjaGOAJykYX0psyMZGS6FT4pFWLBE4lTGGazl6YoCOfJzOaZQputXBjYHw0qwrgucmEkNtC%2BfxpSt5cJaKtgTY6LUJX9XUyl4kFJZqsy%2Fp0mTj5PliwehL7w%3D%3D"
"data":"{"language":"zh-cn", "procType":"4", "refNum":"76207490", "respCode":"00", "respMsg":"success", "resvFld":"", "signCertId":"888" }","signature":"UdehwX2Y6UXhMUDL2zK1CZy3DE399OpsPxMSsBnrJErN4rPuNFdo67R9vUrmoWXIXWUI7MytufmFryLPfB72eklv/RiwYeatLFcP6DmbrUuKb349AeEQzElE4zLiABG895gg60E6wC3E+fPdHeNwAk6H88XGaUf8OGrIq18boUe3j8ZSN0RMNH0OY9lAnwsVzOhVEmfIWBdajztuPqGfZN+KzxmeABwIwKTOD291C/L0Dtw7rJX8/znXuTdbpdXlpJcW5QQU8qjmfo6td8KxZdm" //This sample code is for reference only, "data" field should be encoded to Base64 format
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 5- Inquiring the use of coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Encryption certificate ID | encCertId | AN | 1-128 | O:Optional | Encryption certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | The random number or reference number generated by traffic portal. It is returned in response message as is. | ||
Traffic portal ID | insCode | ANS | 1-11 | M:Mandatory | Traffic portal ID configured in the Marketing Platform | ||
Promotion campaign code | pmtCode | ANS | 1-30 | M:Mandatory | Promotion campaign code configured in the Marketing Platform. | ||
Date and time of operation | procDt | ANS | 14 | M:Mandatory | Format: YYYYMMDDHHMISS | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 5- Inquiring the use of coupon | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | Return the same value filled in the request message. | ||
Response code | respCode | ANS | 2 | M:Mandatory | Response code, see response code reference for details. | ||
Response message | respMsg | ANS | 1-200 | O:Optional | Response message, see response code reference for details. | ||
Number of used coupons | couponUseTotal | N | 1-8 | M:Mandatory | It must be filled in when respCode is 00. For the shared coupon, it returns with the number of the used coupon. For the exclusive coupon, it returns the number of the used coupon only for the traffic portal. | ||
Total number of coupons | couponTotal | N | 1-8 | M:Mandatory | It must be filled in when respCode is 00. For the shared coupon, it returns with the number of the used coupon. For the exclusive coupon, it returns the number of the used coupon only for the traffic portal. | ||
Date and time of operation | procDt | ANS | 14 | M:Mandatory | Format: YYYYMMDDHHMISS | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
"data":"{"encCertId":"888", "insCode":"000520000", "language":"zh-cn", "pmtCode":"160603100020", "procDt":"20180502145152", "procType":"5", "refNum":"05021451052", "resvFld":"710584000001", "signCertId":"888" }","signature":"YwdZQKP6ZtQ6N3xvnzEySYthgKB9an93X3KNPQJXmkcVVImzPpxUBImIfB/bqkiCotlCid1AxenSTtF6TSooVka+q2thJmZlMN7diBYxqJ1Jwwg1PLxFNKwTUZEg80Ym/BvxHcYzpcDi1h4VEmAJ5xawuQkPagKEG+Fjmdsg0lKu8BfP+9jWazlwXebfX1TUoFAn3hQQGC7Wtebx8rDYzuRuMYqCK+73HQ4tIiyO4inObQkXDWY+0SpyXnUcHs/SXvFTS4JtkVFTM/aIVhU8LvlOhKYNqrF" //This sample code is for reference only, "data" field should be encoded to Base64 format
"data":"{"couponUseTotal":1274, "language":"zh-cn", "procDt":"", "procType":"5", "refNum":"05021451052", "respCode":"00", "respMsg":"Success", "resvFld":"", "signCertId":"" }","signature":"JLWGn4O91oga5ieSe4qlagpEJbBIKHN/x+LYPX3B0Hv7pOIfFSyTkF6Juja64JVxUDkEh6o6yv7Bzv+IssEmFWcPuabLWaKARLzQI094GBQK+dwUPRDLd34geBD7iD0o+L1ciK5JH3z0Si1Yv7o8hUL9bR7vV1bWuEGjqVH15toIHx2pthRji50CXq0oL/SOQXZFX3eZ4DDVcxVDHe4tn6Cj2WxSw0tfanv/fwOnGS6QCXnhJhJl72M5FLbFW1et6GQL/Q9b4k/WU1GlJOW33SEN" //This sample code is for reference only, "data" field should be encoded to Base64 format
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 6- Coupon reversal notice | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Encryption certificate ID | encCertId | AN | 1-128 | O:Optional | Encryption certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Traffic portal ID | insCode | ANS | 1-11 | M:Mandatory | Traffic portal ID configured in the Marketing Platform | ||
Promotion campaign code | pmtCode | ANS | 30 | M:Mandatory | Promotion campaign code configured in the Marketing Platform. | ||
Coupon ID | couponId | ANS | 30 | M:Mandatory | The coupon ID. | ||
Reference number | refNum | N | 1-20 | M:Mandatory | The random number or reference number generated by traffic portal. It is returned in response message as is. | ||
The code of country/region in which the transaction occurs | countryCode | N | 4 | O:Optional | Country/region code. E.g., 0344 represents HongKong SAR. | ||
The name of country/region in which the transaction occurs | countryName | ANS | 1-100 | O:Optional | The country/region name. | ||
Transaction currency | txnCurrCode | N | 3 | M:Mandatory | Currency code. E.g., 344 represents HKD. | ||
Transaction amount | txnAmt | ANS | 1-15 | M:Mandatory | The amount before discount and with decimals. | ||
Amount of discount | discountAmt | ANS | 1-15 | M:Mandatory | The amount of discount and with decimals. | ||
Merchant ID | merCode | ANS | 1-15 | O:Optional | |||
Merchant name | merName | ANS | 40 | O:Optional | |||
Merchant longitude and latitude | merLocation | ANS | 60 | O:Optional | E.g., N22°32′37.05E114°03′46.56 | ||
Number of times available for use of the coupon | couponUsableNum | N | 1-6 | O:Optional | The Number of times available for use of the coupon. Its value can only be greater than or equal to 0. | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
Filed name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Type of Operation | procType | AN | 1 | M:Mandatory | 6- Coupon reversal notice | ||
Signature certificate ID | signCertId | AN | 1-128 | M:Mandatory | Signature certificate ID | ||
Display Language | language | AN | 1-5 | M:Mandatory | Zh-cn: Simplified Chinese; en: English | ||
Reference number | refNum | N | 1-20 | M:Mandatory | Return the same value filled in the request message. | ||
Response code | respCode | ANS | 2 | M:Mandatory | Response code, see Appendix for details. | ||
Response message | respMsg | ANS | 1-200 | O:Optional | Response message, see Appendix for details. | ||
Reserved field | resvFld | ANS | 1-500 | O:Optional |
"data":"{"countryCode":"344", "countryName":"Hong Kong", "couponId":"411220288420830543", "discountAmt":"11.000", "encCertId":"899", "insCode":"100280156", "language":"en", "merCode":"701034453110010", "merLocation":"", "merName":"莎莎化粧品有限公司", "pmtCode":"171013100506", "procType":"6", "refNum":"56532798", "resvFld":"", "signCertId":"888", "txnAmt":"180.000", "txnCurrCode":"344" }","signature":"dk4RYL%2BE6d%2BrqpTqQt6Z59799H%2B5%2B6j4Odr0OgdgsQOubLKvXUN%2BqG2bhWkDJqCrscSLBl4%2FUBweydjgb%2BRqRNd0B5MO7umQwFPZPk%2Fn2cLMjRTYmFuZlolwU2hmr0rusnH3krBZOItNCIGU24cK3MTe01R%2BtU8y%2B%2F0gyfdAUVRO6Uj6vGTrSZA84tbSIgf3I96CtbyK7WQIbLKMPuFBuS14hsHYyjBvEIaiRBH3U5RzsXUDt5NBFtywQ%3D%3D"
"data":"{"respCode":"00", "signCertId":"888", "resvFld":"", "respMsg":"success", "refNum":"56532798", "language":"en", "procType":"6" }","signature":"1JcSXWJRLBOwAbuWvzXyXBKZDc+Ukms5/NoX0GdOvAgld4Lnhg8/55qZ2nLMFBCj6G9SsGrUt/bn7IqAyO6Nd5H19v1Z1QA1biPQoRjUG/HmF3qQnBMGkH3DS/1AsFABuGhBetoi7f6xz9PpOzr3F7cRpMueJEL0qiQMMkSK1hgmF4aVJIZNIDqORKLZaM1uh8hgtAjN5eNmsKjCcdyixbOoEBIxA5TvvHx+z6WoBNoI42fcRazYOG3F/ssDaS3KpQ0b+62+cHsmAsAb5vrwpaXsULMrW9H9pAYZYzF9l3G2YVEWkx8CdwyteWYRhyPgv9xxJQn2l7QBYygicayqAQ==" //This sample code is for reference only, "data" field should be encoded to Base64 format
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
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 |