UnionPay International Developer

Open API >Online Payments >UPI Cross-border B2B Platform

UPI Cross-border B2B Platform

Online Payments Merchant Acquirer Internet Payment

UPI Cross-Border B2B Payment & Service Platform offers comprehensive online payment service for import and export enterprises including global e-commerce, international and local trading enterprises.

Sandbox Testing

API Introduction

What is it?

UnionPay Cross-Border B2B Payment & Service Platform offers comprehensive online payment service for import and export enterprises including global e-commerce, international and local trading enterprises. The platform takes advantage of API mode and Portal mode to provide safe, convenient, transparent and efficient of cross-border B2B payment solutions, and promotes trade between China and countries or regions around the world.

Key Features

Safety: UnionPay digital payment and receiving solution

Convenience: Easy to pay at anytime and anywhere to reduce labor and time costs

Transparency: Real-time payment notification and status tracking

Efficiency: Funds arrive in time; Online corporate management tools to enhance productivity

When to Use it?

Online trading scenarios including online marketplace, e-invoice platform and other online platforms, and traditional import and export enterprises and other scenarios

Who Use it?

Online marketplaces, e-invoice platforms and other online platforms, traditional import and export enterprises, as well as acquirers providing online B2B payment service

Where to Use it?

This API is available globally.

Flow Chart

Direct Payment 流程图1.png

Direct Payment

1. Buyer place order in E-Commerce website

2. Buyer jump to B2B platform to make payment

In Direct Payment, online merchant connect with B2B platform by API. This payment is applicable to online portal of E-commerce company

E-invoice payment 流程图2.png

E-invoice Payment

1. Export company register on B2B platform portal and generate e-invoice, payment link, then send link to buyers through email

2. Buyer use UnionPay card to make payment via payment link

E-invoice Payment is applicable to traditional offline exporters, suppliers, manufacturers or distributors.

API Reference

Purchase
Purchase Cancellation
Refund
Inquiry

Interface description

Merchants with access can initiate an order to UnionPay cross-border B2B payment platform via this interface to make their payments. Depending on transaction subtypes, there are two order payments: Direct and E-Invoice ones. The following are related with direct payment mode, unless otherwise noted.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	M:Mandatory	1.0.0	Fixed value:1.0.0
Encoding Method	encoding	ANS	1-20	M:Mandatory	UTF-8	Fixed value:UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	01:RSA
Transaction Type	txnType	N	2	M:Mandatory	01	Value: 01
Transaction Subtype	txnSubType	N	2	M:Mandatory		Value: 01 - Direct Payment
Channel Type	channelType	N	2	M:Mandatory		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	M:Mandatory		0: Direct Access for General Merchants; 1:quirer Access; 2:Platform Merchant Access
Foreground Notification Address	frontUrl	ANS	1-256	C:Conditional		Don’t need to fill in when txnSubType is 02; As for 01,it will return results to merchants interface if the frontUrl is uploaded.
Background Notification Address	backUrl	ANS	1-256	M:Mandatory		Available for returning query results to merchants through the background. The notification about transaction results from the background are sent to merchant if submitted.
Acquirer Institution Code	acqInsCode	AN	8-11	M:Mandatory
Merchant Category	merCatCode	N	4	M:Mandatory
Merchant Code	merId	AN	15	M:Mandatory
Secondary Merchant Code	subMerId	AN	5-15	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Name	subMerName	ANS	1-40	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Abbr.	subMerAbbr	ANS	1-8	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Merchant Order No.	orderId	AN	8-32	M:Mandatory		Generated on the merchant side
Commodity Name	orderName	ANS	1-64	O:Optional
Commodity Type	orderType	N	4	O:Optional
Commodity Quantity	orderNum	N	1-10	O:Optional
Commodity Description	orderDesc	ANS	1-256	O:Optional
Order Sent On	txnTime	N	14	M:Mandatory		The time point when merchants send their transactions, in the forms of YYYYMMDDhhmmss
Payment Timeout Period	payTimeout	N	14	O:Optional		The time point after which this transaction is considered as failed since its payment is overdue, in the forms of YYYYMMDDhhmmss
Order Amount	txnAmt	N	1-12	M:Mandatory		In cents
Order Currency	currencyCode	AN	3	M:Mandatory	156	Default of 156
Risk Information Field	riskRateInfo	ANS	1-2048	O:Optional		Submitted by merchants who require risk control according to their specific needs, in the following formats: {variable name 1=value& variable name 2= value & variable name 3= value }
Jump Address Available for the Failed Foreground Transactions	frontFailUrl	ANS	1-256	C:Conditional		Don’t need to fill in when txnSubType is 02; As for 01, if the fronFailtUrl is uploaded, the page will jump to his/her URL when the payment is failed (just jump occurred, no transaction information transferred)
Reserved Field for Requestor	reqReserved	ANS	1-1024	O:Optional		Reserved field customized by merchants, will be returned as it is when the response to the transaction is occurred
Reserved Field	reserved	ANS	1-2048	O:Optional		Format: BASE64 (variable name 1=value& variable name 2= value& variable name 3=value)

Synchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Fixed value:UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet; 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchants; 1: Acquirer Access; 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Order Sent On	txnTime	N	14	R:Returned		Format: YYYYMMDDhhmmss
Order Amount	txnAmt	N	1-12	R:Returned
Order Currency	currencyCode	AN	3	R:Returned	156	Default of 156
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected
Payment URL	payUrl	ANS	1-512	C:Conditional		Payment URL will be returned only if the Response Code is 00;

Asynchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type:07 - Internet; 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchants; 1: Acquirer Access; 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Order Sent On	txnTime	N	14	R:Returned		Format:YYYYMMDDhhmmss
Order Amount	txnAmt	N	1-12	R:Returned
Order Currency	currencyCode	AN	3	R:Returned	156	Default of 156
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected
Settlement Amount	settleAmt	N	1-12	M:Mandatory
Settlement Currency	settleCurrencyCode	AN	3	M:Mandatory
Settlement Date	settleDate	N	4	M:Mandatory		Format: MMDD
Exchange Date	exchangeDate	N	4	O:Optional		Format: MMDD
Transaction Transferred On	traceTime	N	14	M:Mandatory		Format:YYYYMMDDhhmmss
System Trace No.	traceNo	N	6	M:Mandatory
Transaction ID	transId	AN	8-32	M:Mandatory

Sample code

Request code

Other

{txnType=01,payTimeout=20180811171438,frontUrl=http://www.unionpayintl.com/,currencyCode=344,channelType=07,orderType=00,orderDesc=描述描述,frontFailUrl=http://cn.unionpay.com/,orderName=测试商品,merId=005157806020001,orderNum=1,acqInsCode=00510578,txnSubType=01,txnAmt=665000,version=1.0.0,signMethod=01,backUrl=http://172.19.52.40:9081/epsp-sample/backAsyNotice.do,encoding=UTF-8,reqReserved=test,merCatCode=0602,orderId=20180810171438,signature=bcXG+BMFkQ1fGcF5OP8rs6YXp2lUs6VBrR4qtrtlXqVLz0X9wzpNJCyTxXMz63vf9x2GRoKbn/Pna/USjXSBFeGHyeQrI+H1ZCVJ3A9QYziV+glHOr7xtkIbUipc9k4odnlY4XxHcweLfhQXCmIbfaTqAVUx7gaftg0Iw5sNLc1+27JAp2NU2VYgXGBtJj1wSSZMhCGTqTkF1wS2H3HiGRPscgmleHRjhbheEcf9N42/uY4EyEbEGDLll2S8IY2r02ef4t0nkfVJJU8AuvAW8RJeQNLN4Pp9AGFdV8O7/S3+Hk4Sc1R0fPBqPb6jbBl3/foPCoCXCvf3PnXpSu9IYg==,txnTime=20180810171438,accessType=0,}

Response code

Other

[accessType=0&acqInsCode=00510578&channelType=07&currencyCode=344&encoding=UTF-8&merId=005157806020001&orderId=20180810171438&reqReserved=test&respCode=00&respMsg=Success!&settleAmt=665000&settleCurrencyCode=344&settleDate=0810&signMethod=01&signature=WPqb1ykHNr0ezBySxWIp+FBQn6CmuVJm/XA2VhKNNWyrzYp/UX3TNqB5/CnFvhoZwDexXy8rkcpKBj9tfI21/Wu4DYD4X+q1uEhsCTmZDe1pCfz+bv5q6BpyRqxggjdB37OLNEz8T0+xYJ0Ge9THflF5fBBK8lG+k1hMg1rGG4lEzIoTHdDPWGaFjZvZOxcdVab5NGuUwD8HpUcmO/nBafPE3hngVK9mK+d54d1BeerONGmpD+mYHqWp1vMg6Yj9KfVlhal7LRrmWTQSRswTmjqQJO1j7ZaNZnAzcYxuXHXlWW4GUULkxdlBddVc6iEEXcpYZgrEBklBsvKOPCWcpA==&transId=2018081000005113&txnAmt=665000&txnSubType=01&txnTime=20180810171438&txnType=01&version=1.0.0]

Interface description

For those completed orders being cancelled due to human factors, merchants can initiate purchase cancellation transactions to the Cross-border B2B Payment and Service Platform through this interface. Only those payment orders which are of the current batch and approved on the current day can be cancelled. There is no need to interact with the corresponding cardholder to complete the transaction process since it is occurred in the background.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	M:Mandatory	1.0.0	Fixed value: 1.0.0
Encoding Method	encoding	ANS	1-20	M:Mandatory	UTF-8	Default value: UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	M:Mandatory	02	Value: 02
Transaction Subtype	txnSubType	N	2	M:Mandatory	00	Value: 00
Channel Type	channelType	N	2	M:Mandatory		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	M:Mandatory		0: Direct Access for General Merchants, 1: Acquirer Access, 2: Platform Merchant Access
Background Notification Address	backUrl	ANS	1-256	M:Mandatory		Available for returning query results to merchants through the background. The notification about transaction results from the background are sent to merchant if submitted.
Acquirer Institution Code	acqInsCode	AN	8-11	M:Mandatory
Merchant Category	merCatCode	N	4	M:Mandatory
Merchant Code	merId	AN	15	M:Mandatory
Secondary Merchant Code	subMerId	AN	5-15	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Name	subMerName	ANS	1-40	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Abbr.	subMerAbbr	ANS	1-8	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Merchant Order No.	orderId	AN	8-32	M:Mandatory		Order no. for the cancelled payment, which is generated by merchants
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Amount	txnAmt	N	1-12	M:Mandatory		In cents
Order Sent on	txnTime	N	14	M:Mandatory		Format: YYYYMMDDhhmmss
Risk Information Field	riskRateInfo	ANS	1-2048	O:Optional		Submitted by merchants who require risk control according to their specific needs
Reserved Field for Requestor	reqReserved	ANS	1-1024	O:Optional		Reserved field customized by merchants, will be returned as it is when the response to the transaction is occurred
Reserved Field	reserved	ANS	1-2048	O:Optional		Format: BASE64 (variable name 1=value& variable name 2= value& variable name 3=value)

Synchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Default value: UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for Merchants, 1: Acquirer Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Category	merCatCode	N	4	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Sent On	txnTime	N	14	R:Returned		Format: YYYYMMDDhhmmss
Transaction Amount	txnAmt	N	1-12	R:Returned
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected

Asynchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Default value: UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchants, 1: Acquirer Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Category	merCatCode	N	4	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Sent On	txnTime	N	14	R:Returned		Format: YYYYMMDDhhmmss
Transaction Currency	currencyCode	AN	3	M:Mandatory
Transaction Amount	txnAmt	N	1-2	R:Returned
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected
Settlement Amount	settleAmt	N	1-2	M:Mandatory
Settlement Currency	settleCurrencyCode	AN	3	M:Mandatory
Settlement Date	settleDate	N	4	M:Mandatory		Format: MMDD
Exchange Date	exchangeDate	N	4	C:Conditional		Format: MMDD. Appears if Settlement Currency is inconsistent with Transaction Currency. Value range: MM: 01-12, DD: 01-31
Transaction Transferred On	traceTime	N	14	M:Mandatory		Format: YYYYMMDDhhmmss
System Trace NO.	traceNo	N	6	M:Mandatory
Transaction ID	transId	AN	8-32	M:Mandatory

Sample code

Request code

Other

{txnType=02,origOrderId=20180810171438,channelType=07,merId=005157806020001,acqInsCode=00510578,txnSubType=00,txnAmt=665000,version=1.0.0,signMethod=01,backUrl=http://www.baidu.com,encoding=UTF-8,merCatCode=0602,signature=VmlLodY0z7pPpXUSKkeor21tGOZdNVzGKoWYLa6BPIQcekXy8VlSTUQEGPWYT7fXks4r5mSFrUqxplhincdwJwlAkdAWNvrsKqTTY9DFNMVyPqcgS+2JUsg45T9WYTUPfIXdTjZF5t1z/LJXqoJZYPt0oET8yLodBPW0iDs6N0QfkDWPmCjU+SI+922qOfgKMfv8tDJZrcdAYIUIzGaHjKtncocXu9J0MDKt3dhEwZBl+kYoQJMuimLgzrw7yKi1+xUEPWF5WOYWA+ITD0hQXq6WWBRJJCkJOStYvWyOqNGTi0T7sTNEZRvCpplteAgzLyoFVYr3mYps5ZdDmxfLOw==,orderId=20180810171741,accessType=0,txnTime=20180810171823,}

Response code

Other

[accessType=0&acqInsCode=00510578&channelType=07&currencyCode=344&encoding=UTF-8&merCatCode=0602&merId=005157806020001&orderId=20180810171741&origOrderId=20180810171438&respCode=00&respMsg=Success!&settleAmt=665000&settleCurrencyCode=344&settleDate=0810&signMethod=01&signature=d5RbEyO2SFbOmL3ozHWAXH9uXQzKwpwmEtdX31qb4p+Jun/H8vrHPH5LJehB+J+fEbvfKUIsOhUric5flivaNkfTMA8fgeLIjxZ4n8FUd2FwoWS5L/KPMEeo5DJkXfhqXqq/BbxlqOOQeVN2ertobqgdOxEbmdRlWnuUTnxw1locs0GpKBj3umrAj7Zaiu7sRHNZ0jWoN4C73XjWKMBBaT2lsUiqoJKE6W+Go3c2SAU72aRmFT0qUMCnReZcOzjcrgJPnyCbCB0di5RWYNOkN1KiAtqSsm8YJwlMM9XNz5pXzUzUSZcTwM6WwTqnNoEfYelHMenQPiMDYqxKAQpECw==&transId=20180810171741&txnAmt=665000&txnSubType=00&txnTime=20180810171823&txnType=02&version=1.0.0]

Interface description

For purchase transactions across or on the settlement day(s), merchants can initiate refund transactions to UnionPay cross-border B2B payment platform through this interface to meet the refund needs from their customers. Partial refund and repeated refund are supported. Such transactions occurred in the background will be included in the fund settlement.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	M:Mandatory	1.0.0	Fixed value: 1.0.0
Encoding Method	encoding	ANS	1-20	M:Mandatory	UTF-8	Default value: UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	M:Mandatory	03	Value: 03
Transaction Subtype	txnSubType	N	2	M:Mandatory	00	Value: 00
Channel Type	channelType	N	2	M:Mandatory		Channel Type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	M:Mandatory		0: Direct Access for General Merchants, 1: Acquirer Access, 2: Platform Merchant Access
Background Notification Address	backUrl	ANS	1-256	M:Mandatory		Available for returning query results to merchants through the background. The notification about transaction results from the background are sent to merchant if submitted.
Acquirer Institution Code	acqInsCode	AN	8-11	M:Mandatory		Needs to be submitted if Access Type is Acquirer Access
Merchant Category	merCatCode	N	4	M:Mandatory
Merchant Code	merId	AN	15	M:Mandatory
Secondary Merchant Code	subMerId	AN	5-15	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Name	subMerName	ANS	1-40	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Abbr.	subMerAbbr	ANS	1-8	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Merchant Order No.	orderId	AN	8-32	M:Mandatory		Order no. for the returned commodity, which is generated by merchants
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Amount	txnAmt	N	1-12	M:Mandatory		In cents
Order Sent On	txnTime	N	14	M:Mandatory		Format: YYYYMMDDhhmmss
Risk Information Field	riskRateInfo	ANS	1-2048	O:Optional		Submitted by merchants who require risk control according to the actual situation
Reserved Field for Requestor	reqReserved	ANS	1-1024	O:Optional		Reserved field customized by merchants, will be returned as it is when the response to the transaction is occurred
Reserved Field	reserved	ANS	1-2048	O:Optional		Format: BASE64 (variable name 1=value& variable name 2= value& variable name 3=value)

Synchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value:1.0.0
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Fixed value:UTF-8
Signature	signature	ANS	1-1024	M:Mandatory
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet,08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchants, 1: Acquirer Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Category	merCatCode	N	4	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Sent On	txnTime	N	14	R:Returned		Format: YYYYMMDDhhmmss
Transaction Amount	txnAmt	N	1-12	R:Returned
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected

Asynchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value:1.0.0
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Fixed:UTF-8
Signature	signature	ANS	1-1024	M:Mandatory
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchant, 1: Acquirer Institution Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Category	merCatCode	N	4	R:Returned
Merchant Code	merId	AN	15	R:Returned
Merchant Order No.	orderId	AN	8-32	R:Returned
Original OrderId	origOrderId	AN	8-32	M:Mandatory		Requested OrderId in Purchase Interface
Order Sent On	txnTime	N	14	R:Returned		Format: YYYYMMDDhhmmss
Transaction Currency	currencyCode	AN	3	M:Mandatory
Transaction Amount	txnAmt	N	1-2	R:Returned
Reserved Field for Requestor	reqReserved	ANS	1-1024	R:Returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory		Specific response information is expected
Settlement Amount	settleAmt	N	1-12	M:Mandatory
Settlement Currency	settleCurrencyCode	AN	3	M:Mandatory
Settlement Date	settleDate	N	4	M:Mandatory		Format: MMDD
Exchange Date	exchangeDate	N	4	C:Conditional		Format: MMDD. Appears if Settlement Currency is inconsistent with Transaction Currency. Value range: MM: 01-12, DD: 01-31
Transaction Transferred On	traceTime	N	14	M:Mandatory		Format: YYYYMMDDhhmmss
System Trace No.	traceNo	N	6	M:Mandatory
TransactionID	transId	AN	8-32	M:Mandatory

Sample code

Request code

Other

{txnType=03,origOrderId=20180810171941,channelType=07,merId=005157806020001,acqInsCode=00510578,txnSubType=00,txnAmt=735000,version=1.0.0,signMethod=01,backUrl=http://www.baidu.com,encoding=UTF-8,merCatCode=0602,signature=XhkAS+p76dtv1m/AT/viNoO+bwbW/JZSEvs8YdzdUL/kLxDBS6ExbcNqkCvGy9q6ivEBtd774WuyqzvPQXOEUsqBx7P/TmfSbijv4o4IYjKmIffbbXjUHiic9kvX8uxLhPYUP64Bdubp1exajq3N+YOpMO5fl02P4zNoRrt2Nbnz/3KJTnrinpQ5GKvaUNa3P48fRlHONOv8l819qCW9DRTSQ4HWqhpl0ahhpgjZmT5y+6hMybIZT9L92I7rOGRTN/w0yKytOvvJQUzk9to0H58XN8N2SoPj1lK8HJ+/mxXoWd1jfuV8LYZKlEPVx+sqiIcxCmcCpIqxLyEW/9vCNg==,orderId=20180810171940,accessType=0,txnTime=20180810172036,}

Response code

Other

[accessType=0&acqInsCode=00510578&channelType=07&currencyCode=344&encoding=UTF-8&merCatCode=0602&merId=005157806020001&orderId=20180810171940&origOrderId=20180810171941&respCode=00&respMsg=Success!&settleAmt=735000&settleCurrencyCode=344&settleDate=0810&signMethod=01&signature=UHrPfRsfu+g6EvPeAL2U8S0NbIuxfQVth/d9FsU9DwTDAQd/J0ob1EW9WTAHtL3Ph0Du9/FYnGbWxrLSnY9tH0QsIdjd31tEdaFyiJ0fwsrus/xJ9+Y5Ai0qOzl7zBShsrt0+KPD6DqwHrHcdIxSYHDgz3QYkpzfvmxkuN0vRIdoUDXt96qky+JreOXyAV32QceRlkKnUZE9nNWq+OU2RuVmhMMxdJdqMoL9dtIDkiwKEvHaf/HmK/DgBxnI8i4tlzGjXhd5M+Q8dUQhqeGWrnu2FnvKc64PGvw7OQoleifi8Cq7r6CLPw5tAcMp2n1YTCZDEOZdTi7NZv8LLLurrQ==&transId=20180810171940&txnAmt=735000&txnSubType=00&txnTime=20180810172036&txnType=03&version=1.0.0]

Interface description

For online transactions for which they haven't yet received transaction results, merchants should initiate transaction status inquiry transactions to the cross-border B2B integrated payment platform in order to get them. There is no need to interact with the corresponding cardholder to complete the transaction process since it is occurred in the background.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	M:Mandatory	1.0.0	Fixed value: 1.0.0
Encoding Method	encoding	ANS	1-20	M:Mandatory	UTF-8	Default value: UTF-8
Signature	signature	ANS	1-1024	M:Mandatory		Message summary signature is required
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	M:Mandatory	00	Value: 00
Transaction Subtype	txnSubType	N	2	M:Mandatory	00	Value: 00
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	M:Mandatory		0: Direct Access for General Merchant, 1: Acquirer Institution Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	C:Conditional		Needs to be submitted if Access Type is Acquirer Institution Access
Merchant Category	merCatCode	N	4	M:Mandatory
Merchant Code	merId	AN	15	M:Mandatory
Secondary Merchant Code	subMerId	AN	5-15	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Name	subMerName	ANS	1-40	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Secondary Merchant Abbr.	subMerAbbr	ANS	1-8	C:Conditional		Needs to be submitted if Merchant Type is Platform Merchant Access
Merchant Order No.	orderId	AN	8-32	M:Mandatory		Order No. of transactions being queried
Order Sent On	txnTime	N	14	M:Mandatory		Transaction time of transactions being queried. Format: YYYYMMDDhhmmss
Reserved Field	reserved	ANS	1-2048	O:Optional

Synchronous Response parameters

Filed name	Identifier	Type	Length	Request	Default value	Note
Version No	version	NS	5	R:Returned	1.0.0	Fixed value:1.0.0
Encoding Method	encoding	ANS	1-20	R:Returned	UTF-8	Fixed value:UTF-8
Signature	signature	ANS	1-1024	M:Mandatory
Signature Method	signMethod	N	1-12	M:Mandatory	01	Value: 01 (Meaning RSA is enabled)
Transaction Type	txnType	N	2	R:Returned
Transaction Subtype	txnSubType	N	2	R:Returned
Channel Type	channelType	N	2	R:Returned		Channel type: 07 – Internet, 08 - Mobile
Access Type	accessType	N	1	R:Returned		0: Direct Access for General Merchant, 1: Acquirer Institution Access, 2: Platform Merchant Access
Acquirer Institution Code	acqInsCode	AN	8-11	R:Returned
Merchant Category	merCatCode	N	4	R:Returned
Merchant Code	merId	AN	15	R:Returned
Order Sent On	txnTime	N	14	M:Mandatory		Transaction time of transactions being queried. Format: YYYYMMDDhhmmss
Merchant Order No.	orderId	AN	8-32	R:Returned
Reserved Field for Requestor	reqReserved	ANS	1-1024	O:Optional		Reserved Field for Requestor of transactions being queried is returned
Reserved Field	reserved	ANS	1-2048	O:Optional
Transaction Transferred On	traceTime	N	14	M:Mandatory		Format: YYYYMMDDhhmmss
System Trace No.	traceNo	N	6	M:Mandatory
TransactionID	transId	AN	8-32	M:Mandatory		Query transaction ID
Settlement Date	settleDate	N	4	M:Mandatory		Format: MMDD. Transactions related to funds
Settlement Currency	settleCurrencyCode	AN	3	M:Mandatory		Transactions related to funds
Settlement Amount	settleAmt	N	1-12	M:Mandatory		Transactions related to funds
Exchange Date	exchangeDate	N	4	C:Conditional		Format: MMDD. Appears if Settlement Currency is inconsistent with Transaction Currency. Value range: MM: 01-12, DD: 01-31
Transaction Currency	currencyCode	AN	3	C:Conditional
Transaction Amount	txnAmt	N	1-12	C:Conditional
Response Code of Original Transaction	origRespCode	AN	2	C:Conditional		Returned when the query transaction is successful
Response Information of Original Transaction	origRespMsg	ANS	1-256	C:Conditional
Response Code	respCode	AN	2	M:Mandatory
Response Information	respMsg	ANS	1-256	M:Mandatory

Sample code

Request code

Other

{txnType=00,channelType=07,merId=005157806020001,acqInsCode=00510578,txnSubType=00,version=1.0.0,signMethod=01,encoding=UTF-8,merCatCode=0602,orderId=20180810171941,signature=DWCvU7gDvLO3tgwOEMCtjeW9cCx+xO/KzQVLTBhuumIBC8SeiKA2iv8axZH81roGI8XN019Y+mheKdW8KUb4kUT4sEI0+De0xvW2tu4eex3mhfwMaVdgW5kRdjtfdu8MlqgXyJsxaeGpOg5IbjYbW537kPCwvMGSPbTa+Bcr51xcMMjgYNbXm6k9HfB+pli4/Gd+Pz/ArUOgmju2GmnOGRJ09MZOtXqFWeHkj44L9uRJOFAC35fpmq0sooAQnRgLL5orWg3B/VanuzSrYahlXKwS7WpMiv9uPBDfeFB7HYdHRfPg11E5VvCU0gt1mA15IeB8S90oV+qkx8GL+cPVYg==,accessType=0,txnTime=20180810171941,}

Response code

Other

{txnType=00, currencyCode=344, channelType=07, merId=005157806020001, settleDate=0810, acqInsCode=00510578, origRespMsg=MerInterfacePojo.success.info, origRespCode=00, txnSubType=00, txnAmt=735000, version=1.0.0, signMethod=01, transId=2018081000005115, settleAmt=735000, settleCurrencyCode=344, encoding=UTF-8, merCatCode=0602, orderId=20180810171941, signature=DWCvU7gDvLO3tgwOEMCtjeW9cCx+xO/KzQVLTBhuumIBC8SeiKA2iv8axZH81roGI8XN019Y+mheKdW8KUb4kUT4sEI0+De0xvW2tu4eex3mhfwMaVdgW5kRdjtfdu8MlqgXyJsxaeGpOg5IbjYbW537kPCwvMGSPbTa+Bcr51xcMMjgYNbXm6k9HfB+pli4/Gd+Pz/ArUOgmju2GmnOGRJ09MZOtXqFWeHkj44L9uRJOFAC35fpmq0sooAQnRgLL5orWg3B/VanuzSrYahlXKwS7WpMiv9uPBDfeFB7HYdHRfPg11E5VvCU0gt1mA15IeB8S90oV+qkx8GL+cPVYg==, txnTime=20180810171941, accessType=0}

Steps to Launch

B2B 业务开展流程1.png

B2B 业务开展流程2.png

FAQ and Documentation

Documents:

B2BinvocationSample.rar

Update time: 2019-01-24 11:08:12

Response Code Reference

Response code	Description
00	Succeed
01	System error
05	Accepted, please inquire transaction results later
08	Illegal merchant information
09	Illegal parameter format
10	Wrong message format
11	Wrong verification signature
12	Duplicate transaction
32	No privilege for this transaction
33	Transaction amount exceeds the limit
34	Not found this transaction
36	Not match with original transaction information
39	Beyond the scope of acceptance time for this transaction
61	Invalid card number entered, please confirm and enter it again
65	Transaction failed due to wrong password, validity or CVN2 entered
66	Transaction failed due to incorrect cardholder’s identity information or phone number entered
90	Illegal currency information

Card Product

Online Payment

Mobile QuickPass

QR Code

Cross-Border B2B Service

Token Program

SaaS Card Issuing Service Platform

Block Chain

Platforms

Global Service

Digital Solutions

Industry Solutions

Deferred Online ODA Mode

Real-Time Mode

Frictionless Parking

Transit QR Code Mode

Prompt

Kindly Reminder

Prompt