Open API >Primary Credit Transaction >Remittance & P2P Transfer
Remittance & P2P Transfer
Primary Credit Transaction Developer Acquirer
Remittance & P2P Transfer interface intend to better assist UPI Members outside of Mainland China in implementing primary credit business, including cross-border remittance (MoneyExpress) and domestic P2P transfer,etc.
API Introduction
API Introduction
What is it?

Remittance & P2P Transfer interface intend to better assist UPI Members outside of Mainland China in implementing primary credit business, including but not limited to cross-border remittance and domestic P2P transfer, push purchase and push cash withdrawal, etc., making it easier for UPI members to extend business scope.

Key Features

1. Lower technology threshold and reduce development cost for institutions to luanch business.


2. API other than previous ISO format make it easier for institutions to access.


3. Applies to multiple scenarios, including cross-border remittance, domestic P2P, etc.


4. JWS, JWE are used to sign and encrypt online messagesto ensure security. Sensitive data will be encrypted before stored.


When to Use it?

The business scenarios including cross-border remittance and domestic P2P transfer.

Who Use it?
UPI Members who participate in the primary credit business and software developers.
Where to Use it?
This API is available globally except for Mainland China.
Things to Know

Sending Party (SP in short)refers to:

•Sending Institution in Money Express

•Sending Organization in P2P transfer

•Payer’s Account Management Institution in Push Purchase and Push Cash Withdrawal

•Acquiring Organization in Cash Rebate, B2B Payout, and Tax Refund


Receiving Party (RP) refers to:

•Receiving Institution in Money Express

•Receiving Organization in P2P transfer

•Payee’s Account Management Institution in Push Purchase and Push Cash Withdrawal,

•Issuing Organization in Cash Rebate, B2B Payout, and Tax Refund.


Flow Chart
Flow Chart

汇款流程图.png


API Reference
API Reference
  • CREDIT VERIFY
  • PRIMARY CREDIT
  • PUSH PRIMARY CREDIT
  • MESSAGE RESULT INQUIRY
  • EXCHANGE RATE INQUIRY
  • PUSH PURCHASE REFUND
Interface description
For cross-border remittance and domestic P2P transfer, the Sending Party initiates CREDIT_VERIFY request to UPI API to confirm the payee’s account validity before sending out the PRIMARY_CREDIT request.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Message ID msgID AN 29 M:Mandatory "S00010340001034420171230235959000000" It is used to match a response to its request. The value must uniquely identify any message that the institution initiates on any day. Format: “S”+ Sending Party IIN + Forwarding IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Transmission Date and Time shall be filled by Beijing time (UTC+8).
Sending Party IIN sendPartyIIN AN 8 M:Mandatory "00020344" The distinctive value associated to the Sending Party which manages Payer’s account.
Forwarding IIN forwardingIIN AN 8 M:Mandatory “00010344” The distinctive value associated to the institution that connected to UPI.
Local Transaction Date &Time localTxnDateTime N 10 M:Mandatory Format: MMDDhhmmss
Card Information Capture Method captureMethod N 2 M:Mandatory "94" Valid Values: “01”: Manual; “02”: Magnetic stripe read; "03": Consumer-presented QR Code (QRC), chip information included; "04": Consumer-presented QRC (barcode), chip information excluded; "05": Integrated circuit card read, card data reliable (contact); "07": qUICS Debit/Credit Integrated Circuit Card read (contactless); “10”: Stored Credential; “93”: Merchant-presented QRC, chip information included; “94”: Merchant-presented QRC (barcode), chip information excluded; Other values: Reserved
Merchant ID merchantID ANS 1-15 M:Mandatory The merchant identifier associated to a merchant of the acquirer.
Merchant Category Code mcc N 4 M:Mandatory "6012" A 4-digit numeric value, as defined by [UPI OR], indicates the merchant type.
Merchant Country Code merchantCountry N 3 M:Mandatory “156” A 3-digit numeric value, as defined in Technical Specifications on Bankcard Interoperability – Part VI Annex, indicates the country code of the merchant.
Merchant Name merchantName ANS 1-25 M:Mandatory "UnionPay International"
Merchant City merchantCity ANS 1-12 M:Mandatory "Shanghai"
Terminal ID terminalID ANS 1-8 M:Mandatory The unique value associated to the terminal.
Staged Digital Wallet (SDW) ID sdwID AN 8 C:Conditional "00010344" For definition and business cope of SDW, please refer to [UPI OR]. It is present if SDW is used to initiate the transaction.
Device ID  deviceID ANS 1-40 C:Conditional The distinctive value associated to a device. It shall be IMEI for Android mobile, and IDFV for iOS mobile. It is present if mobile device is used to initiate the transaction.
Transaction Amount trxAmt ANS 1-13 M:Mandatory "101.10" The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, the "." character shall be used to separate the decimals from the integer value, and the "." character may be present even if there are no decimals. The following are examples of valid Transaction Amounts: "98.73", "98" and "98.". The following are NOT valid Transaction Amounts: "98,73" and "3 705".
Transaction Currency trxCurrency N 3 M:Mandatory A 3-digit numeric value, in line with ISO 4217, indicates the currency code of the transaction. The mobile application can display the transaction currency in a readable way, such as "RMB".
Fund Source fundSource N 1 M:Mandatory “3” Valid values:0 – cash ; 1 – debit card; 2 – credit card; 3 – account funds
Encrypted Data encData Object M:Mandatory
Payer’s Name payerName ANS 1-30 M:Mandatory “Zhang San” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted.
Payer’s Account payerAccount ANS 1-19 C:Conditional "6200008888888888888" It can be filled with payer's PAN or token or account number. It is present if und source is not cash.
Payee’s PAN payeePan N 13-19 M:Mandatory "6200008888888888888" It can be filled with payee's PAN or token.
Payee’s Name payeeName ANS 1-30 C:Conditional “Li Si” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted. It is present if required by local regulations.
Payer’s ID Type payerIdType N 2 O:Optional “01” Valid Values: “01”: ID card; “03”: Passport
Payer’s ID Number payerIdNo ANS 1-20 O:Optional "12345678"
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message ID msgID AN 29 R:Returned "S00010340001034420171230235959000000" It is used to match a response to its request. The value must uniquely identify any message that the institution initiates on any day. Format: “S”+ Sending Party IIN + Forwarding IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Transmission Date and Time shall be filled by Beijing time (UTC+8).
Transaction Amount trxAmt ANS 1-13 M:Mandatory "101.10" The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, the "." character shall be used to separate the decimals from the integer value, and the "." character may be present even if there are no decimals. The following are examples of valid Transaction Amounts: "98.73", "98" and "98.". The following are NOT valid Transaction Amounts: "98,73" and "3 705".
Transaction Currency trxCurrency N 3 R:Returned A 3-digit numeric value, in line with ISO 4217, indicates the currency code of the transaction. The mobile application can display the transaction currency in a readable way, such as "RMB".
Business Indication businessIndication N 2 C:Conditional “A1” Valid value: “A1”: Inbound China Remittance; “07”: Cross-border Remittance Outside of Mainland China. “08” Domestic P2P Outside of Mainland China; It is present if successful.
Receiving Party Name receivePartyName ANS 1-60 C:Conditional “ABCD Bank” The name of the Receiving Party which manages Payee’s account. It is present if successful.
Message Response msgResponse Object M:Mandatory
Response Code responseCode AN 2 M:Mandatory "00" It contains a code that defines the response to a request.
Response Message responseMsg S 1-100 M:Mandatory "Approved" It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed on the mobile application to notify the payer of the payment outcome.
Error Detail errorDetail S 1-255 O:Optional “The Issuer response is time out.” It contains additional detail regarding the problem identified in the message. The information is only for debug purpose. It shall not be displayed to the customer, cashier, etc.
Steps to Launch
Steps to Launch

1. Review and Sign MOU & NDA.

Note:MOU( Memorandum of Understanding)

NDA(Non-disclosure Agreement)

2. Sign membership application forms and settlement agreement,  submit the  membership application forms and related documents.

3. Receive LA and IIN assignment from UPI.

Note: LA(Letter of Authority)

4. Develop the system and operational requirements.

5. Preparation check and launch.


Please submit order in Support Center to contact us.


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