Open API >Payment >Remittance & P2P Transfer
Remittance & P2P Transfer
Payment 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 Document
API Document
  • PRIMARY CREDIT
  • MESSAGE RESULT INQUIRY
  • EXCHANGE RATE INQUIRY
Interface description
For cross-border remittance and domestic P2P transfer, push purchase and push cash withdrawal, etc., the Sending Party initiates PRIMARY_CREDIT request to UPI to transfer fund into payee’s account.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Message ID msgID AN 29 M-Must “S0001034420190711235959123456” It is used to match a response to its request. The value must uniquely identify any message that the institutions initiates on any day. The value in the response must match the value in the request. Format: "S"+ INS ID +Transaction Time + Serial Number. INS ID is the 8-digit alphabet and number, uniquely associated with an institution that connected to UPI. Transaction Time is the 14-digit number( YYYYMMDDhhmmss). Serial Number is the 6-digit number uniquely associated with the transaction.
Original Message ID originalMsgID AN 29 C-Condition “S0001034420190711235959123456” The same value as the “msgID” of the corresponding CREDIT VERIFY message. It shall be present in cross-border remittance and domestic P2P business (the value of "businessIndication" is "07", "08" or "A1").
Forwarding IIN forwardingIIN AN 8 M-Must “00010344” The distinctive value associated to the institution that connected to UPI.
Sending Party IIN sendPartyIIN AN 8 M-Must "00020344" The distinctive value associated to the Sending Party which manages Payer’s account.
Card Number Capture Method captureMethod N 2 M-Must "94" Valid Values:01: Manual; 10: Stored Credential; 93: Merchant-presented QRC, chip information included; 94: Merchant-presented QRC (barcode also), chip information excluded; Other values: Reserved
Terminal Type terminalType N 2 M-Must “08” Valid Values: 03: POS; 06: Counter; 07: PC; 08: Mobile Device; Other values: Reserved
Merchant Category Code mcc N 4 M-Must "6012" A 4-digit numeric value, as defined by [UPI OR], indicates the merchant type. In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the MCC is not available by the Payer, it shall be filled with “6012” by default in the request message and the Payee shall respond with the genuine MCC, which will be included in the settlement file.
Merchant Country Code merchantCountry N 3 M-Must “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-Must "UnionPay International" In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the Merchant name is not available by the Payer, it shall be filled with “merchant payment” by default in the request message and the Payee shall respond with the genuine merchant name, which will be included in the settlement file.
Merchant City merchantCity ANS 1-12 C-Condition "Shanghai" In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the Merchant City is not available by the Payer, it could be absent in the request message and the Payee shall respond with the genuine merchant city, which will be included in the settlement file.
Staged Digital Wallet (SDW) ID sdwID AN 8 C-Condition "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-64 C-Condition 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-Must "101.10" It is either key-entered by payer or captured by the mobile application from the merchant-presented QRC data, ID "54". The value in this field includes tip or convenience fee, if applicable. For example, the value of transaction amount (ID "54") in the dynamitic QRC data is "100". The value of fixed convenience fee (ID "56") is "1.10". Then the value of "trxAmt" shall be "101.10".
Transaction Currency trxCurrency N 3 M-Must "156" A 3-digit numeric value, as defined in Technical Specifications on Bankcard Interoperability – Part VI Annex 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".
Transaction Fee Amount trxFeeAmt ANS 1-13 C-Condition "1.10" The tip or the convenience fee. It is present if the Tip or Convenience Fee exists.
Fund Source fundSource N 1 M-Must Valid values:0 – cash; 1 – debit card; 2 – credit card; 3 – account funds
Merchant-presented QR Code Payload mpqrcPayload S 1-2048 C-Condition It contains the raw payload data in the merchant-presented QR code. It is present if it is a Merchant presented QRC transaction.
Business Indication businessIndication N 2 M-Must “A1” Valid value: “07”: Cross-border Remittance Outside of Mainland China; “08” Domestic P2P Outside of Mainland China; “21”: Push Cash Withdrawal; “22”: Push Purchase; “A1”: Inbound China Remittance
Encrypted Data encData Object M-Must
Payer’s Name payerName ANS 1-30 M-Must “Zhang San” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted.
Payer’s PAN payerPan ANS 1-19 C-Condition "6200008888888888888" It is present if bankcard account is used to initiate the transaction.
Payee’s Account payeePan ANS 1-19 M-Must "6200008888888888888"
Payee’s Name payeeName ANS 1-30 C-Condition “Li Si” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted. It is present if required by local regulations.
Payer’s Information payerInfo Object C-Condition This Payer’s Information is in use of verification or anti money laundering. It is present upon business requirement.
Payer’s Birthday payerBirthday N 8 C-Condition Format: YYYYMMDD. It is present upon business requirement.
Payer’s Gender payerGender ANS 1 C-Condition Valid values: M: Male; F: Female; O: Others.; It is present upon business requirement.
Payer’s Nationality payerNationality ANS 3 C-Condition The country code of nationality. It is present upon business requirement.
The Country of Payer’s Permanent Residence permanentCountry ANS 3 C-Condition The country code of the permanent residence.It is present upon business requirement.
The City of Payer’s Permanent Residence permanentCity ANS 40 C-Condition It is present upon business requirement.
The address of Payer’s permanent residence permanentAddress ANS 80 C-Condition It is present upon business requirement.
Indicator of Whether the Payer and Payee is the Same Person isSamePerson N 1 C-Condition This subfield indicates whether the payer and payee is the same person. It shall be filled by payer. Valid values: 0 – The payer and payee is not the same person; 1 – The payer and payee is the same person; It is present upon business requirement.
Additional Data Required by Regulator additionalData ANS 50 C-Condition In cross-border remittance or domestic P2P (the value of "businessIndication" is "07", "08" or "A1"), this field shall be filled as required by local regulator if information above cannot be filled.
Note note ANS 50 C-Condition The note transmits the message that the payer passes to the payee. This tag shall follow rules: a. UTF-8 encoded.;b. For P2P transaction, this tag will be filled in the local language.; Payee can display the note in bill for the cardholder.; It is present upon business requirement.
Risk Information riskInfo Object O-Optional
GPS gps ANS 1-64 O-Optional "+37.12/-121.23" Components: +(-) latitude/+(-) longitude
SIM Card simCard Array 1-200 O-Optional The mobile number of the SIM cards. The mobile phone may have more than one SIM card.
Application User ID appUserID ANS 1-64 O-Optional An alias for the application user ID
User Enrollment Date usrEnrolDate N 6 O-Optional "161230" The date when the cardholder registers in the wallet. Format: YYMMDD
IP Address ipAddress ANS 1-64 O-Optional The public network IP address of the device
Reserved Mobile Number reservedMobileNo ANS 1-25 O-Optional “86-13900000000” The mobile number collected by the application when the user registered his account. The mobile application uses the reserved mobile number to verify the account user. The mobile number format is defined in [ITU-T E.164] . Components:Country code (1-3 digits) + “-” + subscriber number If the country code is not present, UPI API will consider it as a Chinese mobile number.
Device Score deviceScore N 1 O-Optional “5” Valid Values: “1” to “5”. “5” indicates the device is very reliable, and “1” indicates the device is less reliable.
Bill Number billNo ANS 1-25 C-Condition The invoice number or bill number. It may be provided by the merchant or entered by the payer. It is present in Merchant-presented QRC payment and the ID "01" under template "62" exists in the Merchant-presented QRC.
Mobile Number mobileNo ANS 1-25 C-Condition The Mobile Number to be used for multiple use cases, such as mobile top-up and bill payment. It may be provided by the merchant or entered by the payer. The mobile number may be different from the payer mobile number, which will be passed to the Payee / Merchant as additional information. It is present in Merchant-presented QRC payment and the ID "02" under template "62" exists in the Merchant-presented QRC.
Store Label storeLabel ANS 1-25 C-Condition A distinctive value associated to a store. It may be provided by the merchant or entered by the payer. It is present in Merchant-presented QRC payment and the ID "03" under template "62" exists in the Merchant-presented QRC.
Loyalty Number loyaltyNumber ANS 1-25 C-Condition Typically, a loyalty card number. It may be provided by the merchant or entered by the consumer. It is present in Merchant-presented QRC payment and the ID "04" under template "62" exists in the Merchant-presented QRC.
Reference Label referenceLabel ANS 1-25 C-Condition Any value defined by the Merchant or Payee in order to identify the transaction. It may be provided by the merchant or entered by the consumer. It is present in Merchant-presented QRC payment and the ID "05" under template "62" exists in the Merchant-presented QRC.
Customer Label customerLabel ANS 1-25 C-Condition Any value identifying a specific consumer. It may be provided by the merchant or entered by the consumer. It is present in Merchant-presented QRC payment and the ID "06" under template "62" exists in the Merchant-presented QRC.
Terminal Label terminalLabel ANS 1-25 C-Condition A distinctive value associated to a terminal in the store. It may be provided by the merchant or entered by the consumer. It is present in Merchant-presented QRC payment and the ID "07" under template "62" exists in the Merchant-presented QRC.
Purpose of Transaction trxPurpose S 1-25 C-Condition Any value defining the purpose of the transaction. It may be provided by the merchant or entered by the consumer. It is present in Merchant-presented QRC payment and the ID "08" under template "62" exists in the Merchant-presented QRC.
Email Address of the Consumer consumerEmail S 1-100 C-Condition The information requested should be provided by the mobile application in the authorization without unnecessarily prompting the consumer. It will not be verified in the payment procedure, but be provided to the Payee / Merchant as additional information. It is present in Merchant-presented QRC payment and the ID "09" under template "62" contains value "E" in the Merchant-presented QRC.
Address of the consumer consumerAddress S 1-100 C-Condition The information requested should be provided by the mobile application in the authorization without unnecessarily prompting the consumer. It will not be verified in the payment procedure, but be provided to the Payee / Merchant as additional information. It is present in Merchant-presented QRC payment and the ID "09" under template "62" contains value "A" in the Merchant-presented QRC.
Mobile number of the consumer consumerMobileNo ANS 1-25 C-Condition The information requested should be provided by the mobile application in the authorization without unnecessarily prompting the consumer. It will not be verified in the payment procedure, but be provided to the Payee / Merchant as additional information. It is present in Merchant-presented QRC payment and the ID "09" under template "62" contains value "M" in the Merchant-presented QRC.
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message ID msgID AN 29 M-Must “S0001034420190711235959123456” It is used to match a response to its request. The value must uniquely identify any message that the institutions initiates on any day. The value in the response must match the value in the request. Format: "S"+ INS ID +Transaction Time + Serial Number. INS ID is the 8-digit alphabet and number, uniquely associated with an institution that connected to UPI. Transaction Time is the 14-digit number( YYYYMMDDhhmmss). Serial Number is the 6-digit number uniquely associated with the transaction.
Forwarding IIN forwardingIIN AN 8 M-Must “00010344” The distinctive value associated to the institution that connected to UPI.
Sending Party IIN sendPartyIIN AN 8 M-Must "00020344" The distinctive value associated to the Sending Party which manages Payer’s account.
Merchant Category Code mcc N 4 M-Must "6012" A 4-digit numeric value, as defined by [UPI OR], indicates the merchant type. In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the MCC is not available by the Payer, it shall be filled with “6012” by default in the request message and the Payee shall respond with the genuine MCC, which will be included in the settlement file.
Merchant Country Code merchantCountry N 3 M-Must “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-Must "UnionPay International" In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the Merchant name is not available by the Payer, it shall be filled with “merchant payment” by default in the request message and the Payee shall respond with the genuine merchant name, which will be included in the settlement file.
Merchant City merchantCity ANS 1-12 M-Must "Shanghai" In Push Purchase and Push Cash Withdrawal transaction (the value of "businessIndication" is "21" or "22"), when the Merchant City is not available by the Payer, it could be absent in the request message and the Payee shall respond with the genuine merchant city, which will be included in the settlement file.
Transaction Amount trxAmt ANS 1-13 M-Must "101.10" It is either key-entered by payer or captured by the mobile application from the merchant-presented QRC data, ID "54". The value in this field includes tip or convenience fee, if applicable. For example, the value of transaction amount (ID "54") in the dynamitic QRC data is "100". The value of fixed convenience fee (ID "56") is "1.10". Then the value of "trxAmt" shall be "101.10".
Transaction Currency trxCurrency N 3 M-Must "156" A 3-digit numeric value, as defined in Technical Specifications on Bankcard Interoperability – Part VI Annex 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".
Settlement Date settlmtDate N 4 C-Condition Format: MMDD It is present if the transaction is successful.
Settlement Amount settlmtAmt ANS 1-13 C-Condition It is present when transaction currency is different from settlement currency and the transaction is successful.
Settlement Currency settlmtCurrency N 3 C-Condition It is present when transaction currency is different from settlement currency and the transaction is successful.
Settlement Conversion Rate settlmtConvRate N 8 C-Condition It is present when transaction currency is different from settlement currency and the transaction is successful.
Cardholder Billing Amount billingAmt ANS 1-13 C-Condition It is present when transaction currency is different from cardholder billing currency and the transaction is successful.
Cardholder Billing Currency billingCurrency N 3 C-Condition It is present when transaction currency is different from cardholder billing currency and the transaction is successful.
Cardholder Billing Conversion Rate billingConvRate N 8 C-Condition It is present when transaction currency is different from cardholder billing currency and the transaction is successful.
Retrieval Reference Number retrievalReferenceNumber AN 12 C-Condition It is present if successful.
Encrypted Data encData Object None It is present if successful.
Payer’s Name payerName ANS 1-30 M-Must “Zhang San” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted.
Payer’s PAN payerPan ANS 1-19 C-Condition "6200008888888888888" It is present if bankcard account is used to initiate the transaction.
Payee’s Account payeePan ANS 1-19 M-Must "6200008888888888888"
Payee’s Name payeeName ANS 1-30 C-Condition “Li Si” Chinese spelling letters (PIN YIN) are used if Chinese names are submitted. It is present if required by local regulations.
Settlement Key settlementKey Object  C-Condition
Acquirer IIN acquirerIIN AN 8 C-Condition "00010344" It is present if successful.
Forwarding IIN forwardingIIN AN 8 C-Condition "00010344" It is present if successful.
System Trace Audit Number systemTraceAuditNumber N 6 C-Condition "000001" It is present if successful.
Transmission Date and Time transmissionDateTime N 10 C-Condition "1230235959" Format: MMDDhhmmss It is present if successful.
Message Response msgResponse Object None
Response Code responseCode AN 2 M-Must "00" It contains a code that defines the response to a request.
Response Message responseMsg S 1-100 M-Must "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.