By continuing your navigation on our website, you consent to the use of cookies to provide you with better services. To learn more, read our cookies policy.
x
APIs
Products & Solutions
Partner
Support
Sign in
Search
International
中国站
Open API >Online Payments >UnionPay PaybyLink Platform (UPLP)
UnionPay PaybyLink Platform (UPLP)
Online Payments Merchant Acquirer Mobile Payment
The UnionPay PaybyLink Platform (hereinafter referred to as UPLP) establishes a technical platform for Merchants and Acquirers to request for order links.
Sandbox Testing
API Introduction
API Introduction
Key Features

Simple and easily to be implemented

When to Use it?

Online payment merchants or institutions, such as jewelry, luxury goods and related merchants

Who Use it?
Merchants or institutions with system development capabilities
Where to Use it?
Global
Flow Chart
Flow Chart

PAYBYLINK 流程图.png

1. Merchant or institution invokes UPLP interface with order info

2. UnionPay PaybyLink generates payment link and send to cardholder via email or txt message

3. Cardholder confirms the order info then pays the bill by UnionPay App or other UnionPay payment ways

4. PaybyLink system provides payload to UPI System

5. UPI System provides payload to Issuer

6. Issuer completes authorization and responds to UPI

7. UPI system responds to PaybyLink

8. UnionPay PaybyLink responds to the merchant system
API Reference
API Reference
  • Request for a Payment Link Interface
Interface description
The Merchant/Acquirer sends the /paymentLink request to the UPLP. The UPLP returns the payment link URL “linkUrl” to the Merchant/Acquirer.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Message ID msgId AN 29-33 M:Mandatory Valid value: M[AAAAAAAA][YYYYMMDDhhmmss][SSSSSS]. Where, AAAAAAAA = 8-12 alphanumeric characters APP ID assigned by UPI; YYYYMMDDhhmmss = 14 digits Time; SSSSSS = 6 digits random System Trace Audit Number
APP ID appId AN 8-12 M:Mandatory The unique APP ID assigned by UPI
Operator ID operatorId S 1-256 M:Mandatory The email address of the link requestor
Transaction type txnType S 1-32 M:Mandatory Valid values: Purchase; Pre-authorization
Payment Type paymentType S 1-32 M:Mandatory Valid values: SecurePay
Access Type accessType S 1-32 M:Mandatory Valid values: Direct Merchant; Platform Merchant; Acquirer
Merchant ID merId AN 15 M:Mandatory Merchant’s unique identification code assigned by the Acquirer
Order Reference Number orderRef AN 1-25 M:Mandatory The reference number that helps uniquely identify the good or service order.
Order Description orderDes S 1-512 M:Mandatory Description of the goods or service
Order Charge Mode orderChargeMode S 1-32 M:Mandatory Valid values: Quantity- customer enters the quantity; Amount- customer enters the amount
Order Unit Price orderUnitPrice ANS 1-13 C:Conditional The unit price of goods or service; Present if orderChargeMode is filled with “Amount”; The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. Note: For currency having decimal digits, the decimal mark must be present and the number of decimal digits must be consistent with the currency defaults.
Order Stock orderStock N 1-7 C:Conditional The quantity of goods in stock. Present if orderChargeMode is filled with “Quantity”
Order Total Amount orderTotalAmt ANS 1-13 M:Mandatory The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. Note: For currency having decimal digits, the decimal mark must be present and the number of decimal digits must be consistent with the currency defaults.
Currency Code currencyCode N 3 M:Mandatory UnionPay uses numeric currency code defined in ISO-4217 standard.
Notification Channel notifyChannel S 1-16 M:Mandatory The way to delivering the payment link to customers. Valid values: Email,SMS
Shipping Address shippingAdd AN 1-3 M:Mandatory Valid values: Yes, No
Email Address emailAdd S 1-512 C:Conditional Present if the notifyChannel is filled with “Email”. Note: “,” is used as the separator when more than 1 email address to be present.
Phone Number phoneNumber S 1-512 C:Conditional Present if the notifyChannel is filled with “SMS”. Note: “,” is used as the separator when more than 1 phone number to be present.
Language lang ANS 5 M:Mandatory The language used in the email or SMS message, also used for the payment page to display, refer to ISO-639 Language Code and ISO-3166 Country Codes. Valid values: zh-CN; en-US
Payment Link Valid Period validPeriod N 2 M:Mandatory Customized valid period of the payment link. The customized period should not exceed 90 days.
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message ID msgId AN 29-33 R:Returned Valid value: M[AAAAAAAA][YYYYMMDDhhmmss][SSSSSS]. Where, AAAAAAAA = 8-12 alphanumeric characters APP ID assigned by UPI; YYYYMMDDhhmmss = 14 digits Time; SSSSSS = 6 digits random System Trace Audit Number
APP ID appId AN 8-12 R:Returned The unique APP ID assigned by UPI
Operator ID operatorId S 1-256 R:Returned The email address of the link requestor
Payment Link URL linkUrl ANS 1-512 C:Conditional URL of the payment link hosted by UPI. Returned if successful
Message Response msgResponse Object M:Mandatory
Response Code responseCode AN 2 M:Mandatory
Response Message responseMsg S 1-100 M:Mandatory
Error Details errorDetail S 1-255 O:Optional
  • Contact Us
  • If you have any further questions, please register and submit order in your user center.
©Copyright 2002 - 2024. All rights reserved