UnionPay International Developer

Open API >Primary Credit Transaction >PCT-Payout

PCT-Payout

Primary Credit Transaction Acquirer Internet Payment

Payout Transaction API is initiated to transfer fund from an account not owned by an individual to an account designated by a Cardholder

Sandbox Testing

API Introduction

When to Use it?

Payout Transaction is developed for acquirers, which provides capabilities of directly depositing fund to UnionPay cardholders.

Acquirer should determine whether the merchant’s address and information are necessary to be obtained and included in the transaction message according to the requirement of local regulator. Acquirer will ensure that the fund disbursed via Payout service is the income that sellers earns by selling the following goods and services on the merchant’s platform:

Goods

Lodging (Hotels, Motels, and resorts)

Who Use it?

Acquirer.

Where to Use it?

This API is available oustide Mainland China

Flow Chart

流程图.png

API Reference

Reference Foreign Exchange Rate Inquiry
Receiving Card Authentication
Payout Transaction
Payout Transaction Inquiry

Interface description

Reference Foreign Exchange Rate Inquiry API is used to inquire the exchange rate between the transaction currency and the cardholder billing currency.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	M:Mandatory	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	M:Mandatory	Default value: UTF-8
Transaction reference number	transId	AN	8-32	M:Mandatory	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	M:Mandatory	Value: 20 (indicating Reference foreign exchange rate inquiry)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	M:Mandatory	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	M:Mandatory	0: Directly-connected merchant；1: Acquirer
Transaction sending time	sendTime	N	14	M:Mandatory	Transaction sending time, YYYYMMDDhhmmss, Beijing time
Merchant ID	merId	N	15	M:Mandatory	15 digits. Merchant is required to submit
Transaction currency	tranCurrCode	N	3	M:Mandatory	3-digit currency code
Billing currency code	cdhldrCurrCode	N	3	M:Mandatory	3-digit cardholder billing currency code
Reserved field for requestor	reqReserved	ANS	1-2048	O:Optional	The customized field by merchant. It will be returned as it is in the transaction response

Signature

sign

Object

M:Mandatory

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	R:Returned	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	R:Returned	Default value: UTF-8
Transaction reference number	transId	AN	8-32	R:Returned	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	R:Returned	Value: 20 (indicating Reference foreign exchange rate inquiry)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	R:Returned	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	R:Returned	0: Directly-connected merchant；1: Acquirer
Transaction sending time	sendTime	N	14	R:Returned	Transaction sending time, YYYYMMDDhhmmss, Beijing time
Merchant ID	merId	N	15	R:Returned	15 digits. Merchant is required to submit
Transaction currency	tranCurrCode	N	3	R:Returned	3-digit currency code
Billing currency code	cdhldrCurrCode	N	3	R:Returned	3-digit cardholder billing currency code
Reference foreign exchange rate	cdhldrBilConvRate	N	8	M:Mandatory	The foreign exchange rate from transaction currency to cardholder billing currency, which is used to convert the transaction currency in acceptance side to the cardholder billing currency. The decimal digit is represented by the leftmost digit (value 0-7). The 2nd to 8th digits refer to the value of foreign exchange rate whose format is right-aligned and without decimal point. E.g., 71212345 representing the foreign exchange rate is 0.1212345
Reserved field for requestor	reqReserved	ANS	1-2048	R:Returned	The customized field by merchant. It will be returned as it is in the transaction response

Signature

sign

Object

M:Mandatory

Response code	respCode	AN	2	M:Mandatory	00 indicates the inquiry transaction succeeds
Response message	respMsg	ANS	1-256	M:Mandatory
Message Response	msgResponse	Object		M:Mandatory
Signature	signature	ANS	1-2048	M:Mandatory	Fill in the signature of the message digest
Signing method	signMethod	N	1-12	M:Mandatory	Value: 01 (indicating RSA)

Interface description

Receiving Card Authentication API can be used to check whether the receiving card exists.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	M:Mandatory	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	M:Mandatory	Default value: UTF-8
Transaction reference number	transId	AN	8-32	M:Mandatory	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	M:Mandatory	Value: 21 (indicating Receiving Card Authentication)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	M:Mandatory	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	M:Mandatory	0: General merchant；1: Acquirer
Channel type	channelType	NS	5	M:Mandatory	07: Internet；08: Mobile device
Transaction sending time	sendTime	N	14	M:Mandatory	Transaction sending time by merchant.
Merchant ID	merId	AN	15	M:Mandatory	The ID uniquely identifying a merchant which is assigned by acquirer according to UnionPay business rules.
Merchant category code	merCatCode	N	4	M:Mandatory
Account number	accNo	AN	1-2048	M:Mandatory	The transaction account number. It shall be encrypted with encryption public key in the request and encoded with Base64 before submission.
Mobile phone number linked to the account	cdhldrPhone	AN	1-2048	M:Mandatory	Format: International area code-mobile phone number (e.g., Thailand: 66-88888888). Transaction account number. The transaction account number shall be encrypted with encryption public key in the request and encoded with Base64 before submission.
Reserved field for requestor	reqReserved	ANS	1-2048	O:Optional	The customized field by merchant. It will be returned as it is in the transaction response

Signature

sign

Object

M:Mandatory

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	R:Returned	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	R:Returned	Default value: UTF-8
Transaction reference number	transId	AN	8-32	R:Returned	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	R:Returned	Value: 21 (indicating Receiving Card Authentication)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	R:Returned	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	R:Returned	0: General merchant；1: Acquirer
Transaction sending time	sendTime	N	14	R:Returned	Transaction sending time by merchant.
Merchant ID	merId	AN	15	R:Returned	The ID uniquely identifying a merchant which is assigned by acquirer according to UnionPay business rules.
Reserved field for requestor	reqReserved	ANS	1-2048	R:Returned	The customized field by merchant. It will be returned as it is in the transaction response

Message Response

msgResponse

Object

M:Mandatory

Signature

sign

Object

M:Mandatory

Interface description

Payout Transaction API is initiated to transfer fund from an account not owned by an individual to an account designated by a Cardholder.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	M:Mandatory	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	M:Mandatory	Default value: UTF-8
Transaction reference number	transId	AN	8-32	M:Mandatory	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	M:Mandatory	Value: 22 (indicating Payout Transaction)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	M:Mandatory	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	M:Mandatory	0: Directly-connected merchant; 1: Acquirer
Transaction sending time	sendTime	N	14	M:Mandatory	Transaction sending time, YYYYMMDDhhmmss, Beijing time
Merchant ID	merId	N	15	M:Mandatory	Merchant ID
Merchant category code	merCatCode	N	4	M:Mandatory	MCC
Card number	accNo	AN	1-2048	M:Mandatory	Card number for receiving money. It shall be encrypted with encryption public key in the request and encoded with Base64 before submission. If it is required to be returned in response, it is decrypted with signature private key.
Cardholder name	cdhldrName	ANS	1-30	M:Mandatory	Preferred Chinese name. Cardholder's name corresponds to the name in Pinyin format where family name comes before given name separated by space, with the first letters of each name capitalized. Or name in English.
Personal certificate number	cardTypeId	AN	1-2048	M:Mandatory	Value of first 2 digits 01: Personal ID card. It shall be encrypted with encryption public key in the request and encoded with Base64 before submission.
Merchant country code	merCntryCode	N	3	M:Mandatory	3-digit country code. Code of the country/area where the merchant is located
Merchant name	merName	ANS	1-25	M:Mandatory	Merchant name
Merchant city	merCityName	ANS	1-12	M:Mandatory	Name of the city where the merchant is located.
Commodities type	prodCatCode	N	1	M:Mandatory	1: Physical; 2: Service; Currently only physical goods is supported
Transaction amount	txnAmt	N	1-12	M:Mandatory	Decimal digit is determined by the transaction currency.
Transaction currency code	tranCurrencyCode	N	3	M:Mandatory
Reserved field for requestor	reqReserved	ANS	1-2048	O:Optional	The customized field by merchant. It will be returned as it is in the transaction response

Signature

sign

Object

M:Mandatory

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	R:Returned	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	R:Returned	Default value: UTF-8
Transaction reference number	transId	AN	8-32	R:Returned	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	R:Returned	Value: 22 (indicating Payout Transaction)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	R:Returned	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	R:Returned	0: Directly-connected merchant; 1: Acquirer
Transaction sending time	sendTime	N	14	R:Returned	Transaction sending time, YYYYMMDDhhmmss, Beijing time
Transaction transmitting time	traceTime	N	14	C:Conditional	Transaction transmitting time, YYYYMMDDhhmmss, Beijing time.
System trace number	traceNo	N	6	C:Conditional	Returned if transaction succeeds
Merchant ID	merId	N	15	R:Returned	Merchant ID
Transaction amount	txnAmt	N	1-12	R:Returned	Decimal digit is determined by the transaction currency.
Transaction currency code	tranCurrencyCode	N	3	R:Returned
Settlement amount	settleAmt	N	1-12	C:Conditional	Populated by UnionPay if the payment is approved and the "settleCurrCode" has a different value from "tranCurrencyCode".
Settlement currency code	settleCurrCode	N	3	C:Conditional	Populated by UnionPay if the payment is approved and the "settleCurrCode" has a different value from "tranCurrencyCode".
Settlement foreign exchange rate	settleConvRate	N	8	C:Conditional	Populated by UnionPay if the payment is approved and the "settleCurrCode" has a different value from "tranCurrencyCode".
Settlement date	settleDate	N	4	C:Conditional	Populated by UnionPay if the payment is approved. Format:MMDD
Conversion date	converDate	N	4	C:Conditional	Populated by UnionPay if the payment is approved and the "settleCurrCode" has a different value from "tranCurrencyCode". Format:MMDD
Cardholder billing currency code	cdhldrCurrCode	N	3	C:Conditional	Populated by UnionPay if the payment is approved and the "cdhldrCurrCode" has a different value from "tranCurrencyCode".
Cardholder billing amount	cdhldrBilAmt	N	1-12	C:Conditional	Populated by UnionPay if the payment is approved and the "cdhldrCurrCode" has a different value from "tranCurrencyCode".
Cardholder billing foreign exchange rate	cdhldrBilConvRate	N	8	C:Conditional	Populated by UnionPay if the payment is approved and the "cdhldrCurrCode" has a different value from "tranCurrencyCode".

Message Response

msgResponse

Object

M:Mandatory

Signature

sign

Object

M:Mandatory

Interface description

When the merchant does not receive the Payout Transaction response within 30 seconds, it may submit the Payout Transaction Inquiry, using transaction ID of the inquired message to check if the message is approved, or rejected.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	M:Mandatory	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	M:Mandatory	Default value: UTF-8
Transaction reference number	transId	AN	8-32	M:Mandatory	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	M:Mandatory	Value: 23 (indicating Payout Transaction Inquiry)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	M:Mandatory	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	M:Mandatory	0: Directly-connected merchant; 1: Acquirer
Transaction sending time	sendTime	N	14	M:Mandatory	Inquiry transaction sending time, YYYYMMDDhhmmss, Beijing time
Merchant ID	merId	N	15	M:Mandatory	Merchant ID
Original transaction reference number	origTransId	AN	8-32	M:Mandatory	The transaction reference number for the inquired transaction
Reserved field for requestor	reqReserved	ANS	1-2048	O:Optional	The customized field by merchant. It will be returned as it is in the transaction response

Signature

sign

Object

M:Mandatory

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message Information

msgInfo

Object

M:Mandatory

Version number	version	NS	5	R:Returned	Fill in the fixed value 1.0.0
Coding method	encoding	ANS	5	R:Returned	Default value: UTF-8
Transaction reference number	transId	AN	8-32	R:Returned	Transaction reference number, unique value at merchant side
Transaction type	txnType	N	2	R:Returned	Value: 23 (indicating Payout Transaction Inquiry)
Acquirer Institution Identification Number	acqInsCode	AN	8-11	R:Returned	8-digit IIN

Transaction Information

trxInfo

Object

M:Mandatory

Access type	accessType	N	1	R:Returned	0: Directly-connected merchant; 1: Acquirer
Transaction sending time	sendTime	N	14	R:Returned	Inquiry transaction sending time, YYYYMMDDhhmmss, Beijing time
Merchant ID	merId	N	15	R:Returned	Merchant ID
Original transaction reference number	origTransId	AN	8-32	R:Returned	The transaction reference number for the inquired transaction
Reserved field for requestor	reqReserved	ANS	1-2048	R:Returned	The customized field by merchant. It will be returned as it is in the transaction response
Transaction transmitting time	traceTime	N	14	C:Conditional	Transaction transmitting time, YYYYMMDDhhmmss, Beijing time.
Transaction amount	txnAmt	N	1-12	C:Conditional	Decimal digit is not included in this field. It includes 2-digit decimals. Returned if original transaction succeeds.
Transaction currency code	currencyCode	N	3	C:Conditional
Settlement amount	settleAmt	N	1-12	C:Conditional	Decimal digit is not included in this field. It includes 2-digit decimals. Returned if original transaction succeeds.
Settlement currency code	settleCurrCode	N	3	C:Conditional
Cardholder billing amount	cdhldrBilAmt	N	1-12	C:Conditional	Decimal digit is not included in this field. It includes 2-digit decimals. Returned if original transaction succeeds.
Cardholder billing currency code	cdhldrCurrCode	N	3	C:Conditional	It presents when the transaction currency is different as cardholder billing currency
Cardholder billing foreign exchange rate	cdhldrBilConvRate	N	8	C:Conditional	Returned if original transaction succeeds
Settlement foreign exchange rate	settleConvRate	N	8	C:Conditional	It presents when the transaction currency is different as settlement currency
Settlement date	settleDate	N	4	C:Conditional	The settlement date for acquirer and issuer. Format: MMDD
Conversion date	converDate	N	4	C:Conditional	It presents when the transaction currency is different as settlement currency. Format: MMDD

Message Response

msgResponse

Object

M:Mandatory

Original Message Response

origmsgResponse

Object

M:Mandatory

Signature

sign

Object

M:Mandatory

Steps to Launch

Acquirers who join the UnionPay network and devote to process bank card payments for merchants, can develop the UnionPay Payout business. Acquirer has to get local license related to money remittance/transfer service, has to comply with applicable laws and regulations, as well as has to get UPI membership and Payout PCT qualification.

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