One-Stop Cross-Border Shopping — Shop the World
UnionPay Content & Service Platform (UCSP) for Channel Partner
UnionPay Content & Service Platform (UCSP) for Service Provider
UnionPay Transportation Solutions
Card Not Present Payment assists Acquirers to implement UPI E-Commerce products via JSON message, including 3-D Secure, SecurePlus and ExpressPay.
This set of APIs allow acquirers to connect to UPI system with JSON message instead of traditional message in ISO 8385 format.
Using Json Message Format, Card Not Present Payment provides standardized Intefaces to developers, making it easy and convenient to access.
Online E-Commerce Payment
Card Not Present Payment shall be used combining other UnionPay products, including 3DS 2.0, SecurePlus, ExpressPay.
Card Not Present Payment Process differs when combining with different products.
When combining with 3DS or SecurePlus, process would be authentication flow followed by authorization flow, i.e. step 1-10
When combining with ExpressPay, process would be authorization flow only, i.e. step 5-10
Authentication Flow:
1. Merchant send authentication request(3DS or SecurePlus) to UPI
2. UPI forward request to issuer
3. Issuer return authentication request to UPI
4. UPI return authentication to merchant
Authorization Flow:
5. Merchant initiate transaction to acquirer host
6. Acquirer host send request to UPI by Card Not Present Payment API
7. UPI send request to Issuer
8.9.10 Issuer return response to each party
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Staged Digital Wallet (SDW) ID | sdwID | AN | 8 | C:Conditional | "00010344" | For definition and business cope of SDW, please refer to [UPI OR]. It is present if SDW is used to initiate the transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Staged Digital Wallet (SDW) Name | sdwName | ANS | 25 | C:Conditional | For definition and business cope of SDW, please refer to [UPI OR]. It is present if SDW is used to initiate the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Card Information Capture Method | captureMethod | N | 2 | M:Mandatory | “01” | 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 | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals,"." shall be used to separate decimals from integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | "1.10" | 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 | “ABCDE01” | 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 | Convenience store is represented by "5411". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Country Code | merchantCountry | N | 3 | M:Mandatory | "156" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | merchantName | ANS | 1-25 | M:Mandatory | "UnionPay International" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | "Shanghai" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ecommerce Data | eComData | Object | M:Mandatory | e-Commerce transaction specific data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Risk Information | riskInfo | Object | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||
Encrypted Data | encData | Object | O:Optional | JWE |
|||||||||||||||||||||||||||
|
PAN Last 4 Digit | panLast4 | N | 4 | O:Optional | “1234” | The last 4 digits of PAN. Returned to acquirer based on configuration. | ||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate the decimals from the integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | [{“discountAmt”:”20”,”discountNote”:”Uplan discount”}, | 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 | “131.10” | 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 | “101.10” | 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. | |||||||||||||||||||||||||
Retrieval Reference Number | retrievalReferenceNumber | AN | 12 | C:Conditional | Populated by UnionPay if the payment is approved. | ||||||||||||||||||||||||||
Settlement Date | settlementDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if the payment is approved. Format: MMDD | |||||||||||||||||||||||||
Settlement Currency | settlementCurrency | N | 3 | C:Conditional | “840” | 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 | “15.17” | 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 | "0.15000" | 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 | “840” | 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 | “15.17” | 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, "." shall be used to separate the decimals from the integer value, and "." 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 | "0.15000" | Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency" | |||||||||||||||||||||||||
Conversion Date | conversionDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists, Format: MMDD | |||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Staged Digital Wallet (SDW) ID | sdwID | AN | 8 | C:Conditional | "00010344" | For definition and business cope of SDW, please refer to [UPI OR]. It is present if SDW is used to initiate the transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Staged Digital Wallet (SDW) Name | sdwName | ANS | 25 | C:Conditional | For definition and business cope of SDW, please refer to [UPI OR]. It is present if SDW is used to initiate the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Card Information Capture Method | captureMethod | N | 2 | M:Mandatory | ”01” | Valid Values: “01”: - "MANUAL"; “10”: "STORED_CREDENTIAL S"; Reserved Values: “07”: ”:"NFC"; “05”:”ONTACT"; “02”: "MAGSTRIPE"; “00”: "UNKNOWN" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate decimals from integer, and "." character may be present even if there are no decimals. 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 | "156" | 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 | "1.10" | 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 | “ABCDE01” | 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 | Convenience store is represented by "5411". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Country Code | merchantCountry | N | 3 | M:Mandatory | "156" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | merchantName | ANS | 1-25 | M:Mandatory | "UnionPay International" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | "Shanghai" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ecommerce Data | eComData | Object | M:Mandatory | e-Commerce transaction specific data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Risk Information | riskInfo | Object | O:Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||
|
Authorization Identification Response | authCode | AN | 6 | None | “000000” | 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 | None | “1234” | The last 4 digits of PAN. Returned to acquirer based on configuration. | |||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate decimals from integer, and "." character may be present even if there are no decimals. 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 | "156" | 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 | None | [{“discountAmt”:”20”,”discountNote”:”Uplan discount”}, | 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 | None | “131.10” | 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 | None | “101.10” | 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, "." shall be used to separate decimals from integer, and "." may be present even if there are no decimals. | |||||||||||||||||||||||||
Retrieval Reference Number | retrievalReferenceNumber | AN | 12 | None | Populated by UnionPay if the payment is approved. | ||||||||||||||||||||||||||
Cardholder Billing Currency | cardholderBillingCurrency | N | 3 | None | “840” | 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 | None | “15.17” | 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 | None | "0.15000" | Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency" | |||||||||||||||||||||||||
Conversion Date | conversionDate | N | 4 | None | "1230" | Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists.Format: MMDD | |||||||||||||||||||||||||
Message Response | msgResponse | Object | None | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to link original pre-authorization transaction. The value shall be the “msgID” value of the PREAUTH. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Card Information Capture Method | captureMethod | N | 2 | M:Mandatory | ”01” | Valid Values: “01”: - "MANUAL"; “10”: "STORED_CREDENTIAL S"; Reserved Values: “07”: “”:"NFC"; “05”: "CONTACT" ; “02”: "MAGSTRIPE"; “00”: "UNKNOWN" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authorization Identification Response | authCode | AN | 6 | M:Mandatory | “000000” | The value shall be filled with the authorization code obtained in the pre-authorization transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate the decimals from the integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | "1.10" | 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 | “ABCDE01” | 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 | Convenience store is represented by "5411". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Country Code | merchantCountry | N | 3 | M:Mandatory | "156" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant Name | merchantName | ANS | 1-25 | M:Mandatory | "UnionPay International" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | "Shanghai" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Risk Information | riskInfo | Object | O:Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to link original pre-authorization transaction. The value shall be the “msgID” value of the PREAUTH. | |||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Authorization Identification Response | authCode | AN | 6 | O:Optional | “000000” | The value shall be filled with the authorization code obtained in the pre-authorization transaction. | ||||||||||||||||||||||||
PAN Last 4 Digit | panLast4 | N | 4 | O:Optional | “1234” | The last 4 digits of PAN. Returned to acquirer based on configuration. | |||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate the decimals from the integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | [{“discountAmt”:”20”,”discountNote”:”Uplan discount”}, | 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 | “131.10” | 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 | “101.10” | 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. | |||||||||||||||||||||||||
Retrieval Reference Number | retrievalReferenceNumber | AN | 12 | C:Conditional | Populated by UnionPay if the payment is approved. | ||||||||||||||||||||||||||
Settlement Date | settlementDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if the payment is approved. Format:MMDD | |||||||||||||||||||||||||
Settlement Currency | settlementCurrency | N | 3 | C:Conditional | “840” | 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 | “15.17” | 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 | "0.15000" | 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 | “840” | 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 | “15.17” | 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 | "0.15000" | Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency" | |||||||||||||||||||||||||
Conversion Date | conversionDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists. Format:MMDD | |||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S” + Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | When it is used to cancel purchase transaction, the value shall be the “msgID” value of the PURCHASE. When it is used to cancel pre-authorization transaction, the value shall be the “msgID” value of the PREAUTH. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the PREAUTH_COMPLETION. | |||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||
|
Authorization Identification Response | authCode | AN | 6 | C:Conditional | “000000” | 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 | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate the decimals from the integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | “ABCDE01” | 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. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S” + Acquirer IIN + Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Acquirer IIN | acquirerIIN | AN | 8 | M:Mandatory | "00010344" | The distinctive value associated to the Acquirer. | |||||||||||||||||||||||||
Forwarding IIN | forwardingIIN | AN | 8 | M:Mandatory | “00010344” | The Identifier associate to the payment processor. If the transaction is initiated by the Acquirer, this field shall be filled in with Acquirer IIN. If the transaction is initiated by Gateway, PSP, Payment facilitator, etc., this field shall be filled in with the corresponding identifier assigned by UPI. | |||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | When it is used to cancel purchase transaction, the value shall be the “msgID” value of the PURCHASE. When it is used to cancel pre-authorization transaction, the value shall be the “msgID” value of the PREAUTH. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the PREAUTH_COMPLETION. | |||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||
|
Authorization Identification Response | authCode | AN | 6 | O:Optional | “000000” | 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 | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate the decimals from the integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. omponents: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | When it is used to cancel purchase transaction, the value shall be the “msgID” value of the PURCHASE. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the PREAUTH_COMPLETION. | |||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||
|
Authorization Identification Response | authCode | AN | 6 | C:Conditional | “000000” | 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 | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate decimals from integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | M:Mandatory | Generated by Merchant, and it should be unique at merchant side. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. omponents: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | When it is used to cancel purchase transaction, the value shall be the “msgID” value of the PURCHASE. When it is used to cancel pre-authorization completion transaction, the value shall be the “msgID” value of the PREAUTH_COMPLETION. | |||||||||||||||||||||||||
Encrypted Data | encData | Object | M:Mandatory | JWE |
|||||||||||||||||||||||||||
|
PAN Last 4 Digit | panLast4 | N | 4 | O:Optional | “1234” | The last 4 digits of PAN. Returned to acquirer based on configuration. | ||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | M:Mandatory | "101.10" | The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. When the amount includes decimals, "." shall be used to separate decimals from integer value, and "." may be present even if there are no decimals. 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 | "156" | 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 | "1230" | Populated by UnionPay if the refund is approved. Format:MMDD | |||||||||||||||||||||||||
Settlement Currency | settlementCurrency | N | 3 | C:Conditional | “840” | 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 | “15.17” | 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 | "0.15000" | Populated by UnionPay if the refund is approved and the "settlementCurrency" has a different value from "trxCurrency" | |||||||||||||||||||||||||
Conversion Date | conversionDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if "settlementAmt"exists. Format:MMDD | |||||||||||||||||||||||||
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | The same value of the “msgID” in the inquired message. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message ID | msgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | It is used to match a response to its request. The value must uniquely identify any message that the Acquirer initiates on any day. The value in the response must match the value in the request. Components: “S”+ Acquirer IIN +Forwarding IIN+ Transmission Year (YYYY) + Transmission Date and Time (MMDDhhmmss) + System Trace Audit Number (6 numeric digits) | |||||||||||||||||||||||||
Original Message ID | originalMsgID | AN | 37 | M:Mandatory | "S00010340001034420171230235959000000" | The same value of the “msgID” in the inquired message. | |||||||||||||||||||||||||
PAN Last 4 Digit | panLast4 | N | 4 | O:Optional | “1234” | The last 4 digits of PAN. Returned to acquirer based on configuration. | |||||||||||||||||||||||||
Transaction Amount | trxAmt | ANS | 1-13 | C:Conditional | "101.10" | 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 | "156" | 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 | [{“discountAmt”:”20”,”discountNote”:”Uplan discount”}, | 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 | “131.10” | 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 | “101.10” | 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. | |||||||||||||||||||||||||
Settlement Date | settlementDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if the payment is approved. Format:MMDD | |||||||||||||||||||||||||
Settlement Currency | settlementCurrency | N | 3 | C:Conditional | “840” | 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 | “15.17” | 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 | "0.15000" | 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 | “840” | 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 | “15.17” | 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 | "0.15000" | Populated by UnionPay if the payment is approved and the "cardholderBillingCurrency" has a different value from "trxCurrency" | |||||||||||||||||||||||||
Conversion Date | conversionDate | N | 4 | C:Conditional | "1230" | Populated by UnionPay if either "settlementAmt" or “cardholderBillingAmt”exists. Format:MMDD | |||||||||||||||||||||||||
Retrieval Reference Number | retrievalReferenceNumber | AN | 12 | C:Conditional | Populated by UnionPay if the inquired transaction is approved. | ||||||||||||||||||||||||||
Original Message Response | origMsgResponse | Object | C:Conditional | ||||||||||||||||||||||||||||
|
Message Response | msgResponse | Object | M:Mandatory | |||||||||||||||||||||||||||
|
Developers should either perform the role of Acquirers or system developer to apply for business launch.
Please submit order to contact us.