UnionPay International Developer

Interface description

After the consumer selects Click to Pay on the Merchant’s website, the Merchant sends UPSRC_CHECKOUT request to UPI SRCi. UPI SRCi processes the request and returns the HTTP response with the response body being NULL.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Note
Message ID	msgID	AN	44	M:Mandatory	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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).
Transaction Type	transactionType	ANS	1-30	M:Mandatory	Type of transaction initiated for which the SRC Checkout request is sent. Filled with “PURCHASE” by default.
Local Transaction Date &Time	localTxnDateTime	N	10	M:Mandatory	Format: MMDDhhmmss
Acquirer IIN	acquirerIIN	AN	8	M:Mandatory	The unique value assigned by UPI to uniquely identify the Acquirer.
Merchant ID	merchantID	ANS	1-15	M:Mandatory	The unique value assigned by the Acquirer to uniquely identify the Merchant within the Acquirer’s system.
Merchant Category Code	mcc	N	4	M:Mandatory	A 4-digit numeric value, as defined by [UPI OR], indicates the merchant type.
Merchant Country Code	merchantCountry	N	3	M:Mandatory	A 3-digit numeric value
Merchant Name	merchantName	ANS	1-25	M:Mandatory
Merchant Abbreviation	merchantAbbr	ANS	1-8	M:Mandatory
Secondary Merchant ID	subMerchantID	AN	5-25	C:Conditional	It is filled when the Merchant is a Platform Merchant.
Secondary Merchant Name	subMerchantName	ANS	1-40	C:Conditional	It is filled when the Merchant is a Platform Merchant.
3DS Preference	threeDsPreference	ANS	1-20	O:Optional	Merchant’s 3DS preferences. Valid values: “NONE”, which indicates 3DS is not to be performed. “SELF”, which indicates 3DS is to be performed by the Merchant itself. The default value is “NONE” if the field is not submitted.
Transaction Amount	trxAmt	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. 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.
Transaction Currency	trxCurrency	N	3	M:Mandatory	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".
Payload Type for Checkout	payloadTypeIndicatorCheckout	ANS	1-20	M:Mandatory	Valid Values: “SUMMARY”, which indicates payload is not to be returned in CHECKOUT_RESULT_NOTIFICATION. “PAYMENT”, which indicates payment payload is to be returned in CHECKOUT_RESULT_NOTIFICATION
Merchant Back-end URL	backUrl	ANS	1-256	O:Optional	The URL is used by the Merchant backend to receive the checkout result in CHECKOUT_RESULT_NOTIFICATION interface.
JWS Signature	signature	ANS	1-2048	M:Mandatory	Filled with the value of UPI-JWS signature, which is calculated in line with Section 5.2 JWS Signature in UPI Server-based API General Requirements. PLEASE NOTE that the JWS Payload is the entity body of HTTP message excluding the “signature” data field.

Interface description

In pop-up pages, the consumer selects the specific payment card, and completes card verification. Then, UPI SRCi receives checkout result from the specific SRC system, and sends the checkout result to Merchant in CHECKOUT_RESULT_NOTIFICATION message.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

M:Mandatory

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Masked Card

maskedCard

Object

M:Mandatory

SRC Digital Card Reference ID	srcDigitalCardId	AN	1-36	M:Mandatory	It is the reference representing the PAN or Payment Token that uniquely identify the underlying PAN. A single PAN can have one or more SRC Digital Card Reference IDs.
PAN Bin	panBin	N	6-8	M:Mandatory	First significant digits of the PAN included in an unmasked form.
PAN Last Four	panLastFour	N	4	M:Mandatory	Attribute of the Payment Card that represents the last four digits of the PAN included in an unmasked form. Note: “panLastFour” is returned for display purpose.
Token Bin Range	tokenBinRange	N	6-8	C:Conditional	Specific BIN range or subset of the BIN Range that has been designated only for the purpose of issuing Payment Tokens included in an unmasked form. It is returned if Payment Token is used.
Token Last Four	tokenLastFour	N	4	C:Conditional	Last four digits of the Payment Token included in an unmasked form. It is returned if Payment Token is used.
Payment Account Reference	paymentAccountReference	N	1-29	O:Optional	A non-financial reference assigned to each unique PAN and used to link a Payment Account represented by that PAN to affiliated Payment Tokens.

Masked Consumer

maskedConsumer

Object

M:Mandatory

Masked Consumer Identity

maskedConsumerIdentity

Object

M:Mandatory

Identity Provider	identityProvider	ANS	6-8	O:Optional	Entity or organisation that collected and verifies the identity. Filled with “SRC” by default.
Identity Type	identityType	ANS	4	M:Mandatory	Type of Consumer Identity transmitted or collected. Valid values: “EMAIL_ADDRESS” “MOBILE_PHONE_NUMBER”
Masked Identity Value	maskedIdentityValue	ANS	1-255	M:Mandatory	Masked Consumer Identifier value. For example, masked email address or masked mobile phone number.

Encrypted Payload

encryptedPayload

JWE Object

C:Conditional

It is present if the Merchant requests “PAYMENT” payload in original UPSRC_CHECKOUT message.

Primary Account Number

token

Object

C:Conditional

Filled with the token representing the Cardholder account. It is present if the Merchant requests “PAYMENT” payload in original UPSRC_CHECKOUT message.

Dynamic Data

dynamicData

Array

C:Conditional

It is present if the Merchant requests “PAYMENT” payload in original UPSRC_CHECKOUT message.

Payment Account Reference	paymentAccountReference	N	1-29	O:Optional	A non-financial reference assigned to each unique PAN and used to link a Payment Account represented by that PAN to affiliated Payment Tokens.
Payment Token	paymentToken	AN	1-19	C:Conditional	It is present if the Merchant requests “PAYMENT” payload in original UPSRC_CHECKOUT message.
Token Expiration Month	tokenExpirationMonth	N	2	C:Conditional	It is present if “paymentToken” is present. Format: MM
Token Expiration Year	tokenExpirationYear	N	4	C:Conditional	It is present if “paymentToken” is present. Format: YYYY
Dynamic Data Expiration	dynamicDataExpiration	N	1-25	O:Optional	The time stamp of the expiration time of the dynamic data. Filled with the number of seconds from 1970-01-01T00:00:00Z UTC.
Dynamic Data Type	dynamicDataType	ANS	1-50	C:Conditional	Type of dynamic data required in the payload. It is present if the Merchant requests “PAYMENT” payload in original UPSRC_CHECKOUT message. Filled with “CARDHOLDER_AUTHENTICATION_CRYPTOGRAM” by default.
Dynamic Data Value	dynamicDataValue	String	236	C:Conditional	Value of the dynamic data. Conditionality: Required when the value of dynamicDataType is not set to NONE

Message Response

msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a UPSRC_CHECKOUT.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the checkout 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	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.

JWS Signature

signature

ANS

1-2048

M:Mandatory

Filled with the value of UPI-JWS signature

Interface description

After the Merchant receives the successful checkout result in CHECKOUT_RESULT_NOTIFICATION, and the consumer further confirms the payment on Merchant’s website, the Merchant may send MERCHANT_GET_PAYLOAD to get transaction credentials for authorizations. UPI SRCi returns the result to the Merchant and, conditionally, an encrypted payload.

Request Method

HTTP POST

Request Parameter

Field name	Identifier	Type	Length	Request	Note
Message ID	msgID	AN	44	M:Mandatory	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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits)； Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).
Original Message ID	originalMsgID	AN	44	M:Mandatory	The same value as the “msgID” of the original UPSRC_CHECKOUT message.
Local Transaction Date &Time	localTxnDateTime	N	10	M:Mandatory	Format: MMDDhhmmss
Acquirer IIN	acquirerIIN	AN	8	M:Mandatory	The unique value assigned by UPI to uniquely identify the Acquirer.
Merchant ID	merchantID	ANS	1-15	M:Mandatory	The unique value assigned by the Acquirer to uniquely identify the Merchant within the Acquirer’s system.
Payload Type Indicator	payloadTypeIndicator	ANS	1-20	M:Mandatory	Valid Values: “PAYMENT”, which indicates payload is to be returned

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits)； Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Acquirer IIN

acquirerIIN

AN

8

R:Returned

The unique value assigned by UPI to uniquely identify the Acquirer.

Merchant ID

merchantID

ANS

1-15

R:Returned

The unique value assigned by the Acquirer to uniquely identify the Merchant within the Acquirer’s system.

Masked Card

maskedCard

Object

M:Mandatory

SRC Digital Card Reference ID	srcDigitalCardId	AN	1-36	M:Mandatory	It is the reference representing the PAN or Payment Token that uniquely identify the underlying PAN. A single PAN can have one or more SRC Digital Card Reference IDs.
PAN Bin	panBin	N	6-8	M:Mandatory	First significant digits of the PAN included in an unmasked form.
PAN Last Four	panLastFour	N	4	M:Mandatory	Attribute of the Payment Card that represents the last four digits of the PAN included in an unmasked form.
Token Bin Range	tokenBinRange	N	6-8	C:Conditional	Specific BIN range or subset of the BIN Range that has been designated only for the purpose of issuing Payment Tokens included in an unmasked form. It is returned if Payment Token is used.
Token Last Four	tokenLastFour	N	4	C:Conditional	Last four digits of the Payment Token included in an unmasked form. It is returned if Payment Token is used.
Payment Account Reference	paymentAccountReference	N	1-29	O:Optional	A non-financial reference assigned to each unique PAN and used to link a Payment Account represented by that PAN to affiliated Payment Tokens.

Masked Consumer

maskedConsumer

Object

M:Mandatory

Masked Consumer Identity

maskedConsumerIdentity

Object

M:Mandatory

Identity Provider	identityProvider	ANS	6-8	O:Optional	Entity or organisation that collected and verifies the identity. Filled with “SRC” by default.
Identity Type	identityType	ANS	4	M:Mandatory	Type of Consumer Identity transmitted or collected. Valid values: “EMAIL_ADDRESS”； “MOBILE_PHONE_NUMBER”；
Masked Identity Value	maskedIdentityValue	ANS	1-255	M:Mandatory	Masked Consumer Identifier value. For example, masked email address or masked mobile phone number.

Encrypted Payload

encryptedPayload

JWE Object

C:Conditional

It is present upon request for “PAYMENT” payload.

Primary Account Number

token

Object

C:Conditional

Filled with the token representing the Cardholder account. It is present upon request for “PAYMENT” payload.

Payment Account Reference	paymentAccountReference	N	1-29	O:Optional	A non-financial reference assigned to each unique PAN and used to link a Payment Account represented by that PAN to affiliated Payment Tokens.
Payment Token	paymentToken	AN	1-19	C:Conditional	It is present upon request for “PAYMENT” payload.
Token Expiration Month	tokenExpirationMonth	N	2	C:Conditional	It is present if “paymentToken” exists. Format: MM
Token Expiration Year	tokenExpirationYear	N	4	C:Conditional	It is present if “paymentToken” exists.Format: YYYY

Dynamic Data

dynamicData

Array

C:Conditional

It is present upon request for “PAYMENT” payload.

Dynamic Data Expiration	dynamicDataExpiration	N	1-25	O:Optional	The time stamp of the expiration time of the dynamic data. Filled with the number of seconds from 1970-01-01T00:00:00Z UTC.
Dynamic Data Type	dynamicDataType	ANS	1-50	C:Conditional	Type of dynamic data required in the payload. It is present upon request for “PAYMENT” payload.
Dynamic Data Value	dynamicDataValue	String	236	C:Conditional	Value of the dynamic data. Conditionality: Required when the value of dynamicDataType is not set to NONE

Message Response

msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a UPSRC_CHECKOUT.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the checkout 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	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.

Interface description

Merchant notify UPI SRCi about the outcome of a checkout event in EVENT_RESULT_NOTIFICATION.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). .Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

M:Mandatory

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Acquirer IIN

acquirerIIN

AN

8

M:Mandatory

The unique value assigned by UPI to uniquely identify the Acquirer.

Merchant ID

merchantID

ANS

1-15

M:Mandatory

The unique value assigned by the Acquirer to uniquely identify the Merchant within the Acquirer’s system.

Checkout Event Type

checkoutEventType

AN

2

M:Mandatory

Event type associated with the update. Valid values: “00” Place Order; “01”: Authorization; “02”: Capture; “03”: Refund; “04”: Cancel (Authorization Reversal); “05”: Fraud; “06”: Chargeback; “07”: Cancel before Authorization; “08”: Authorization for account validation

Checkout Event Status

checkoutEventStatus

AN

2

M:Mandatory

Status of the checkout event. Valid values: “01”: Created; “02”: Confirmed; “03”: Cancelled; “04”: Fraud Cancelled; “05”: Others

Confirmation Status

confirmationStatus

AN

2

M:Mandatory

Status of the event associated with the update. Valid values: “01”: Success; “02”: Failure; “03”: Other; “04”: Timeout

Network Authorization Code

networkAuthorizationCode

S

1-25

O:Optional

Authorisation code associated with an approved transaction.

Network Transaction Identifier

networkTransactionIdentifier

S

1-25

O:Optional

Unique authorisation related tracing value assigned by a Payment Network and provided in an authorisation response.

Payment Network Reference

paymentNetworkReference

S

1-25

C:Conditional

It shall be filled with the Retrieval Reference Number if the original payment transaction is successful.

Transaction Amount

trxAmt

ANS

1-13

M:Mandatory

Filled with the transaction amount in the original payment transaction. 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.

Transaction Currency

trxCurrency

N

3

M:Mandatory

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".

Discount Details

discountDetails

Array

C:Conditional

The details of the discount in the original payment transaction. Present if the discounts exist. If there is no discount, Discount Details and Original Amount should not be present.

Original Amount

originalAmount

ANS

1-13

O:Optional

Filled with the original transaction amount before discount in the original payment transaction. If there is no discount, Discount Details and Original Amount should not be present.

Original Message Response

origMsgResponse

Object

M:Mandatory

It shall be filled with message response obtained in the original transaction.

Original Message Response Code	origResponseCode	AN	2	M:Mandatory	It shall be filled with the “responseCode” obtained in the original message. It shall be filled if it is obtained in the original transaction.
Original Response Message	origResponseMsg	S	1-100	O:Optional	It shall be the “responseMessage" of the original message. It shall be filled if it is obtained in the original transaction.
Original Error Details	origErrorDetail	S	1-255	O:Optional	It shall be the “errorDetail" of the original message.

Interface description

SRC_PURCHASE API is used for purchase transaction that goods or services are delivered to consumers immediately.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Acquirer IIN

acquirerIIN

AN

8

M:Mandatory

The distinctive value associated to the Acquirer.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Original Message ID

originalMsgID

AN

44

M:Mandatory

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Encrypted Data

encData

Object

M:Mandatory

JWE

Primary Account Number	pan	AN	1-19	M:Mandatory	Encrypted with the public key of the Encryption Certificate. The "pan" can be the card number or a token representing the Cardholder account.
PAN Expiry Date	panExpiryDate	N	4	C:Conditional	Encrypted with the public key of the Encryption Certificate. Expiration date of the account number or token in YYMM format. Required when ECI value is 07. Not required when ECI value is 05, 06, 09, 10
CNP Check Value	cvn2	N	3	O:Optional	Encrypted with the public key of the Encryption Certificate

Card Information Capture Method

captureMethod

N

2

M:Mandatory

Valid Values: • “01”: - "MANUAL" • “10”: "STORED_CREDENTIALS" Reserved Values: • “07”: "NFC" • “05”: "CONTACT" • “02”: "MAGSTRIPE" • “00”: "UNKNOWN"

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

M:Mandatory

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Transaction Fee Amount

trxFeeAmt

ANS

1-13

C:Conditional

The tip or the convenience fee. Present if the Tip or Convenience Fee exists

Coupon Information

couponInfo

ANS

1-30

O:Optional

Merchant ID

merchantID

ANS

1-15

M:Mandatory

The distinctive value associated to the Merchant. The value must uniquely identify any Merchant of the Acquirer.

Secondary Merchant ID

subMerID

AN

5-15

C:Conditional

Applied if access type is platform merchant access

Merchant order number

orderID

AN

8-40

M:Mandatory

Generated by Merchant, and it should be unique at merchant side.

Merchant Category Code

mcc

N

4

M:Mandatory

Merchant Country Code

merchantCountry

N

3

M:Mandatory

Merchant Name

merchantName

ANS

1-25

M:Mandatory

Secondary Merchant name

subMerName

ANS

1-40

C:Conditional

Applied if access type is platform merchant access

Merchant City

merchantCity

ANS

1-12

M:Mandatory

Ecommerce Data

ecomData

Object

M:Mandatory

e-Commerce transaction specific data

Terminal Type	terminalType	N	2	M:Mandatory	Valid Values: “07”: PC; Reserved Values: “00”: UNKNOWN
Electronic Commerce Indicator	eci	N	2	C:Conditional	Valid Values: “05” – 3DS Authenticated transaction; “06” – 3DS Attempt transaction; “07” – 3DS non-authenticated transaction; “09” – Non-3DS Authenticated transaction, which applies to SecurePlus. “10” – Non-authenticated transaction, which applies to ExpressPay.
Authentication Value	authValue	ANS	28	C:Conditional	Present if ECI value of 05, 06
Authentication ID	authTrxID	ANS	36	C:Conditional	Present if ECI value of 05, 06, 07

Risk Information

riskInfo

Object

O:Optional

GPS	gps	ANS	1-64	O:Optional	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	The date when the cardholder registers in the wallet. 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	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	Valid Values: “1” to “5”. “5” indicates the device is very reliable, and “1” indicates the device is less reliable.

Low Risk Indicator

lowRiskInd

Object

O:Optional

e-Commerce transaction specific data

Low value exemption

lowValueExempt

N

1

O:Optional

Valid Values：0- Low value exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment

TRA exemption

traExempt

N

1

O:Optional

Valid Values：0- TRA exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it to be low risk in accordance with the criteria defined by PSD2/RTS

Trusted/Whitelisted merchant exemption

whitelistMerchantExempt

N

1

O:Optional

Valid Values：0- Trusted/Whitelisted merchant exemption does not apply to the transaction. 1- Transaction exempt from SCA as it originated at a merchant trusted by the cardholder

Secure corporate payment exemption

secureCorpExempt

N

1

O:Optional

Valid Values：0- Secure corporate payment exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a secure corporate payment

Delegated authentication exemption

delegatedAuthExempt

N

1

O:Optional

Valid Values：0- Delegated authentication exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a delegated authenticated transaction

Merchant initiated transaction

mit

N

1

O:Optional

Valid Values：0- Merchant initiated transaction scenario does not apply to the transaction; 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a merchant initiated transaction

B2B Payment Indicator

b2bPayInd

N

2

C:Conditional

Valid Values：04- Card based payment- direct payment; 05- Card based payment-e-invoice payment API mode; 06- Card based payment- e-invoice payment- Portal mode

Related Transaction Information

rtInfo

AN

42

C:Conditional

Components: original message type (0100/0200) + original system trace number (6 numeric digits) + original system date and time (MMDDhhmmss) + “000” + original Acquirer IIN + “000” + forwarding IIN. It is mandatory for the Acquirer to fill this information in the debt recovery of transit transactions.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Authorization Identification Response

authCode

AN

6

O:Optional

The authorization code for the approved transaction assigned by the Issuer. The value will be present when the transaction request is authorized by the Issuer.

PAN Last 4 Digit

panLast4

N

4

O:Optional

The last 4 digits of PAN. Returned to acquirer based on configuration.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

R:Returned

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Discount Details

discountDetails

Array

O:Optional

The details of discount. The discount information could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Original Amount

originalAmount

ANS

1-13

O:Optional

The original amount, which could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Cost Amount

costAmount

ANS

1-13

O:Optional

The cost amount after the discount, indicating the amount the Cardholder actually pays for the transaction when a promotion is involved. 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 cost amount could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Retrieval Reference Number

retrievalReferenceNumber

AN

12

C:Conditional

Populated by UnionPay if the payment is approved.

Dynamic Data

dynamicData

Object

C:Conditional

Specific data of SRC transaction

Dynamic Data Expiration	dynamicDataExpiration	N	1-25	O:Optional	The time stamp of the expiration time of the dynamic data. Filled with the number of seconds from 1970-01-01T00:00:00Z UTC.
Dynamic Data Type	dynamicDataType	ANS	1-50	O:Optional	Type of dynamic data required in the payload. Filled with “CARDHOLDER_AUTHENTICATION_CRYPTOGRAM” by default.
Dynamic Data Value	dynamicDataValue	String	236	C:Conditional	Value of the dynamic data. Conditionality: Required when the value of dynamicDataType is not set to NONE

Settlement Date

settlementDate

N

4

C:Conditional

Populated by UnionPay if the payment is approved. MMDD

Settlement Currency

settlementCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates acquirer’s settlement currency. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Amount

settlementAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Conversion Rate

settlementConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345 . Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Cardholder Billing Currency

cardholderBillingCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the card account. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Amount

cardholderBillingAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Conversion Rate

cardholderBillingConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345 . Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Conversion Date

conversionDate

N

4

C:Conditional

Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists

Message Response

　msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

Interface description

The SRC_PREAUTH API is used for requesting approval of transactions. Subsequent SRC_PREAUTH_COMPLETION API is required to enable the clearing and settlement of an approved transaction.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Acquirer IIN

acquirerIIN

AN

8

M:Mandatory

The distinctive value associated to the Acquirer.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Original Message ID

originalMsgID

AN

44

M:Mandatory

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Encrypted Data

encData

Object

M:Mandatory

JWE

Primary Account Number	pan	AN	1-19	M:Mandatory	Encrypted with the public key of the Encryption Certificate. The "pan" can be the card number or a token representing the Cardholder account.
PAN Expiry Date	panExpiryDate	N	4	C:Conditional	Encrypted with the public key of the Encryption Certificate.Expiration date of the account number or token in YYMM format. Required when ECI value is 07. Not required when ECI value is 05, 06, 09, 10
CNP Check Value	cvn2	N	3	O:Optional	Encrypted with the public key of the Encryption Certificate

Card Information Capture Method

captureMethod

N

2

M:Mandatory

Valid Values:• “01”: - "MANUAL" • “10”: "STORED_CREDENTIALS" Reserved Values: • “07”: "NFC" • “05”: "CONTACT" • “02”: "MAGSTRIPE" • “00”: "UNKNOWN"

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

M:Mandatory

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Transaction Fee Amount

trxFeeAmt

ANS

1-13

C:Conditional

The tip or the convenience fee. Present if the Tip or Convenience Fee exists

Coupon Information

couponInfo

ANS

1-30

O:Optional

Merchant ID

merchantID

ANS

1-15

M:Mandatory

The distinctive value associated to the Merchant. The value must uniquely identify any Merchant of the Acquirer.

Secondary Merchant ID

subMerID

AN

5-15

C:Conditional

Applied if access type is platform merchant access

Merchant order number

orderID

ANS

8-40

M:Mandatory

Generated by Merchant, and it should be unique at merchant side.

Merchant Category Code

mcc

N

4

M:Mandatory

Merchant Country Code

merchantCountry

N

3

M:Mandatory

Merchant Name

merchantName

ANS

1-25

M:Mandatory

Secondary Merchant Name

subMerName

ANS

1-40

C:Conditional

Applied if access type is platform merchant access

Merchant City

merchantCity

ANS

1-12

M:Mandatory

Ecommerce Data

ecomData

Object

M:Mandatory

e-Commerce transaction specific data

Terminal Type	terminalType	N	2	M:Mandatory	Valid Values: “07”: PC; Reserved Values: “00”: UNKNOWN
Electronic Commerce Indicator	eci	N	2	C:Conditional	Valid Values:“05” – 3DS Authenticated transaction; “06” – 3DS Attempt transaction; “07” – 3DS non-authenticated transaction; “09” – Non-3DS Authenticated transaction, which applies to SecurePlus. “10” – Non-authenticated transaction, which applies to ExpressPay.
Authentication Value	authValue	ANS	28	C:Conditional	Present if ECI value of 05, 06
Authentication ID	authTrxID	ANS	36	C:Conditional	Present if ECI value of 05, 06, 07

Dynamic Data

dynamicData

Object

C:Conditional

Specific data of SRC transaction

Dynamic Data Expiration	dynamicDataExpiration	N	1-25	O:Optional	The time stamp of the expiration time of the dynamic data. Filled with the number of seconds from 1970-01-01T00:00:00Z UTC.
Dynamic Data Type	dynamicDataType	ANS	1-50	O:Optional	Type of dynamic data required in the payload. Filled with “CARDHOLDER_AUTHENTICATION_CRYPTOGRAM” by default.
Dynamic Data Value	dynamicDataValue	String	236	C:Conditional	Value of the dynamic data. Conditionality: Required when the value of dynamicDataType is not set to NONE

Risk Information

riskInfo

Object

O:Optional

GPS	gps	ANS	1-64	O:Optional	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	The date when the cardholder registers in the wallet. 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	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	Valid Values: “1” to “5”. “5” indicates the device is very reliable, and “1” indicates the device is less reliable.

Low Risk Indicator

lowRiskInd

Object

O:Optional

e-Commerce transaction specific data

Low value exemption	lowValueExempt	N	1	O:Optional	Valid Values：0- Low value exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment
TRA exemption	traExempt	N	1	O:Optional	Valid Values：0- TRA exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it to be low risk in accordance with the criteria defined by PSD2/RTS
Trusted/Whitelisted merchant exemption	whitelistMerchantExempt	N	1	O:Optional	Valid Values：0- Trusted/Whitelisted merchant exemption does not apply to the transaction. 1- Transaction exempt from SCA as it originated at a merchant trusted by the cardholder
Secure corporate payment exemption	secureCorpExempt	N	1	O:Optional	Valid Values：0- Secure corporate payment exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a secure corporate payment
Delegated authentication exemption	delegatedAuthExempt	N	1	O:Optional	Valid Values：0- Delegated authentication exemption does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a delegated authenticated transaction
Merchant initiated transaction	mit	N	1	O:Optional	Valid Values：0- Merchant initiated transaction scenario does not apply to the transaction. 1- Transaction exempt from SCA as the merchant/acquirer has determined it as a merchant initiated transaction

B2B Payment Indicator

b2bPayInd

N

2

C:Conditional

Valid Values：04- Card based payment- direct payment. 05- Card based payment-e-invoice payment API mode. 06- Card based payment- e-invoice payment- Portal mode. B2B institution and Merchant shall submit this indicator

Related Transaction Information

rtInfo

AN

42

C:Conditional

Components: original message type (0100/0200) + original system trace number (6 numeric digits) + original system date and time (MMDDhhmmss) + “000” + original Acquirer IIN + “000” + forwarding IIN. It is mandatory for the Acquirer to fill this information in the debt recovery of transit transactions.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

The same value as the “msgID” of the original UPSRC_CHECKOUT message.

Authorization Identification Response

authCode

AN

6

C:Conditional

The authorization code for the approved transaction assigned by the Issuer. The value will be present when the transaction request is authorized by the Issuer.

PAN Last 4 Digit

panLast4

N

4

O:Optional

The last 4 digits of PAN. Returned to acquirer based on configuration.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

R:Returned

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Discount Details

discountDetails

Array

O:Optional

The details of discount. The discount information could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Original Amount

originalAmount

ANS

1-13

O:Optional

The original amount, which could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Cost Amount

costAmount

ANS

1-13

O:Optional

The cost amount after the discount, indicating the amount the Cardholder actually pays for the transaction when a promotion is involved. 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 cost amount could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Retrieval Reference Number

retrievalReferenceNumber

AN

12

C:Conditional

Populated by UnionPay if the payment is approved.

Cardholder Billing Currency

cardholderBillingCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the card account. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Amount

cardholderBillingAmt

ANS

1-13

C:Conditional

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.Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Conversion Rate

cardholderBillingConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Conversion Date

conversionDate

N

4

C:Conditional

Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists. MMDD

Message Response

　msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

Interface description

The SRC_PREAUTH_COMPLETION API is used to request for clearing and settlement of a previous approved pre-authorization request. By requirement of UPI Operation Regulations, the SRC_PREAUTH_COMPLETION request must be submitted within 30 days of the original pre-authorization request.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Acquirer IIN

acquirerIIN

AN

8

M:Mandatory

The distinctive value associated to the Acquirer.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Original Message ID

originalMsgID

AN

44

M:Mandatory

It is used to link original pre-authorization transaction. The value shall be the “msgID” value of the SRC_PREAUTH.

Encrypted Data

encData

Object

M:Mandatory

JWE

Card Information Capture Method

captureMethod

N

2

M:Mandatory

Valid Values:• “01”: - "MANUAL"• “10”: "STORED_CREDENTIALS".Reserved Values:• “07”: "NFC" • “05”: "CONTACT" • “02”: "MAGSTRIPE" • “00”: "UNKNOWN"

Authorization Identification Response

authCode

AN

6

M:Mandatory

The value shall be filled with the authorization code obtained in the pre-authorization transaction.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

M:Mandatory

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Transaction Fee Amount

trxFeeAmt

ANS

1-13

C:Conditional

The tip or the convenience fee.Present if the Tip or Convenience Fee exists

Coupon Information

couponInfo

ANS

1-30

O:Optional

Merchant ID

merchantID

ANS

1-15

M:Mandatory

The distinctive value associated to the Merchant. The value must uniquely identify any Merchant of the Acquirer.

Secondary Merchant ID

subMerID

AN

5-15

C:Conditional

Applied if access type is platform merchant access

Merchant order number

orderID

ANS

8-40

M:Mandatory

Generated by Merchant, and it should be unique at merchant side.

Merchant Category Code

mcc

N

4

M:Mandatory

Merchant Country Code

merchantCountry

N

3

M:Mandatory

Merchant Name

merchantName

ANS

1-25

M:Mandatory

Secondary Merchant Name

subMerName

ANS

1-40

C:Conditional

Applied if access type is platform merchant access

Merchant City

merchantCity

ANS

1-12

M:Mandatory

Risk Information

riskInfo

Object

O:Optional

GPS	gps	ANS	1-64	O:Optional	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	The date when the cardholder registers in the wallet. 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	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	Valid Values: “1” to “5”. “5” indicates the device is very reliable, and “1” indicates the device is less reliable.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

It is used to link original pre-authorization transaction. The value shall be the “msgID” value of the SRC_PREAUTH.

Authorization Identification Response

authCode

AN

6

O:Optional

The value shall be filled with the authorization code obtained in the pre-authorization transaction.

PAN Last 4 Digit

panLast4

N

4

O:Optional

The last 4 digits of PAN. Returned to acquirer based on configuration.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

R:Returned

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Discount Details

discountDetails

Array

O:Optional

The details of discount. The discount information could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Original Amount

originalAmount

ANS

1-13

O:Optional

The original amount, which could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Cost Amount

costAmount

ANS

1-13

O:Optional

The cost amount after the discount, indicating the amount the Cardholder actually pays for the transaction when a promotion is involved. 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 cost amount could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Retrieval Reference Number

retrievalReferenceNumber

AN

12

C:Conditional

Populated by UnionPay if the payment is approved.

Settlement Date

settlementDate

N

4

C:Conditional

Populated by UnionPay if the payment is approved.

Settlement Currency

settlementCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates acquirer’s settlement currency. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Amount

settlementAmt

ANS

1-13

C:Conditional

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.Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Conversion Rate

settlementConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Cardholder Billing Currency

cardholderBillingCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the card account. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Amount

cardholderBillingAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Conversion Rate

cardholderBillingConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Conversion Date

conversionDate

N

4

C:Conditional

Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists. MMDD

Message Response

　msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

Interface description

VOID API can be used to reverse previously approved transaction or can also be submitted in case of timeouts.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Acquirer IIN

acquirerIIN

AN

8

M:Mandatory

The distinctive value associated to the Acquirer.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Original Message ID

originalMsgID

AN

44

M:Mandatory

When it is used to cancel purchase transaction, the value shall be the “msgID” value of the SRC_PURCHASE. When it is used to cancel pre-authorization transaction, the value shall be the “msgID” value of the SRC_PREAUTH. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the SRC_PREAUTH_COMPLETION.

Encrypted Data

encData

Object

M:Mandatory

JWE

Authorization Identification Response

authCode

AN

6

C:Conditional

This field shall be present if it is present in the last related transaction. The value of this field shall be obtained from the response message of the original transaction.

Transaction Amount

trxAmt

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. 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".The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

M:Mandatory

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Merchant ID

merchantID

ANS

1-15

M:Mandatory

The distinctive value associated to the Merchant. The value must uniquely identify any Merchant of the Acquirer.

Secondary Merchant ID

subMerID

AN

5-15

C:Conditional

Applied if access type is platform merchant access

Merchant order number

orderID

ANS

8-40

O:Optional

Generated by Merchant, and it should be unique at merchant side.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

When it is used to cancel purchase transaction, the value shall be the “msgID” value of the SRC_PURCHASE. When it is used to cancel pre-authorization transaction, the value shall be the “msgID” value of the SRC_PREAUTH. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the SRC_PREAUTH_COMPLETION.

Authorization Identification Response

authCode

AN

6

O:Optional

This field shall be present if it is present in the last related transaction. The value of this field shall be obtained from the response message of the original transaction.

Transaction Amount

trxAmt

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. 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".The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

R:Returned

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Message Response

　msgResponse

　Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

Interface description

The REFUND API is used to submit merchandise returns for card and token based transactions.

Request Method

HTTP POST

Request Parameter

Field name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

M:Mandatory

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

M:Mandatory

When it is used to cancel purchase transaction, the value shall be the “msgID” value of the SRC_PURCHASE. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the SRC_PREAUTH_COMPLETION.

Local Transaction Date &Time

localTxnDateTime

N

10

M:Mandatory

Format: MMDDhhmmss

Encrypted Data

encData

Object

M:Mandatory

JWE

Authorization Identification Response

authCode

AN

6

C:Conditional

This field shall be present if it is present in the last related transaction. The value of this field shall be obtained from the response message of the original transaction.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

M:Mandatory

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Merchant order number

orderID

ANS

8-40

O:Optional

Generated by Merchant, and it should be unique at merchant side.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits) Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

When it is used to cancel purchase transaction, the value shall be the “msgID” value of the SRC_PURCHASE. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the SRC_PREAUTH_COMPLETION.

PAN Last 4 Digit

panLast4

N

4

O:Optional

The last 4 digits of PAN. Returned to acquirer based on configuration.

Transaction Amount

trxAmt

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. 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". The value must include the transaction fee amount if it exists. The transaction amount in the response message may be not equal to that in the request message due to discount activity, which will be used in settlement.

Transaction Currency

trxCurrency

N

3

R:Returned

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist.

Retrieval Reference Number

retrievalReferenceNumber

AN

12

C:Conditional

Populated by UnionPay if the refund is approved.

Settlement Date

settlementDate

N

4

C:Conditional

Populated by UnionPay if the refund is approved.

Settlement Currency

settlementCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates acquirer’s settlement currency. Populated by UnionPay if the refund is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Amount

settlementAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the refund is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Conversion Rate

settlementConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345. Populated by UnionPay if the refund is approved and the "settlementCurrency" has a different value from "trxCurrency"

Conversion Date

conversionDate

N

4

C:Conditional

Populated by UnionPay if "settlementAmt"exists

Message Response

　msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

Interface description

When the inquired message is financial message such as the purchase or the pre-authorization completion, the original message response and settlement information will be returned. Otherwise, only the response of the inquired message will be returned.

Request Method

HTTP POST

Request Parameter

	Field name	Identifier	Type	Length	Request	Default value	Note
	Message ID	msgID	AN	44	M:Mandatory		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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).
	Original Message ID	originalMsgID	AN	44	M:Mandatory		The same value of the “msgID” in the inquired message.

Synchronous Response parameters

Filed name

Identifier

Type

Length

Request

Default value

Note

Message ID

msgID

AN

44

R:Returned

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”+ Merchant ID + Acquirer IIN + Transmission Date and Time (YYYYMMDDhhmmss) + System Trace Audit Number (6 numeric digits). Note 1: Merchant ID in “msgID” is of 15 bytes. If “merchantID” is less than 15 bytes, it is right-padded with spaces in “msgID”. Note 2: Transmission Date and Time shall be filled by Beijing time (UTC+8).

Original Message ID

originalMsgID

AN

44

R:Returned

The same value of the “msgID” in the inquired message.

PAN Last 4 Digit

panLast4

N

4

O:Optional

The last 4 digits of PAN. Returned to acquirer based on configuration.

Authorization Identification Response

authCode

AN

6

C:Conditional

The authorization code for the approved transaction assigned by the Issuer. The value will be present when the transaction request is authorized by the Issuer. Populated by UnionPay if the payment is approved.

Transaction Amount

trxAmt

ANS

1-13

C:Conditional

The cost amount of the payment. The transaction amount returned in the MSG_RESULT_INQUIRY message may be not equal to that in the payment request message due to discount activity. Populated by UnionPay if the payment is approved.

Transaction Currency

trxCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the transaction. The currency also applies to the "discount", "costAmount", and "trxFeeAmt" if they exist. Populated by UnionPay if the payment is approved.

Discount Details

discountDetails

Array

O:Optional

The details of discount.The discount information could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Original Amount

originalAmount

ANS

1-13

O:Optional

The original amount, which could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Cost Amount

costAmount

ANS

1-13

O:Optional

The cost amount after the discount, indicating the amount the Cardholder actually pays for the transaction when a promotion is involved. 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 cost amount could be displayed to the cardholder in the terminal interface or the receipt printed to the cardholder.

Settlement Date

settlementDate

N

4

C:Conditional

　Populated by UnionPay if the payment is approved. MMDD

Settlement Currency

settlementCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates acquirer’s settlement currency. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Amount

settlementAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the payment is approved and the "settlementCurrency" has a different value from "trxCurrency"

Settlement Conversion Rate

settlementConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point.

Cardholder Billing Currency

cardholderBillingCurrency

N

3

C:Conditional

A 3-digit numeric value, as defined by [ISO 4217], that indicates the currency code of the card account. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Amount

cardholderBillingAmt

ANS

1-13

C:Conditional

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. Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Cardholder Billing Conversion Rate

cardholderBillingConvRate

ANS

1-9

C:Conditional

The 1st digit indicates the number position where the decimal point should be moved from the right (allowed values are 0–7). The 2nd-final digits indicate the value of the conversion rate, and are right justified with no decimal point. For example, 71212345 indicates that the conversion rate is 0.1212345 Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency"

Conversion Date

conversionDate

N

4

C:Conditional

Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists

Retrieval Reference Number

retrievalReferenceNumber

AN

12

C:Conditional

Populated by UnionPay if the inquired transaction is approved.

Original Message Response

origMsgResponse

Object

C:Conditional

Original Message Response Code	origResponseCode	AN	2	C:Conditional	When the result of the message inquired is not available, the Message Status shall be “PG”. Otherwise, it shall be the “responseCode” of the original message. It is present if the “originalMsgID” is presented in the request message. Present if the “originalMsgID” is presented in the request message
Original Response Message	origResponseMsg	S	1-100	C:Conditional	It shall be the “responseMessage" of the message inquired. It is present if "origResponseCode" is presented. Present if "origResponseCode"
Original Error Details	origErrorDetail	S	1-255	O:Optional	It shall be the “errorDetail" of the message inquired.

Message Response

msgResponse

Object

M:Mandatory

Response Code	responseCode	AN	2	M:Mandatory	It contains a code that defines the response to a request. Refer to the Response Code and Message for the valid values.
Response Message	responseMsg	S	1-100	M:Mandatory	It contains the transaction result and the rejection reason if the transaction fails. The value of this field can be displayed by the Merchant to notify the consumer of the payment outcome. Refer to the Response Code and Message for details.
Error Details	errorDetail	S	1-255	O:Optional	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.

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