--- title: "cancel" method: POST path: "/payment/{merchantTransID_of_payment}/cancel" tags: ["payment"] --- # cancel `POST /payment/{merchantTransID_of_payment}/cancel` ## Path parameters - `merchantTransID_of_payment` string, required ## Headers - `Authorization` string, required - `Content-type` string, required - `DateTime` string, required - `KeyID` string, required - `MsgID` string - `SignType` string, required - `Idempotency-Key` string ## Request body - object - `merchantTransInfo` object, required — This is the information for merchant to identify this Transaction

Usage Instruction
For each new POST request, including PaymentMethod, Payment, Capture, Cancel, Refund, a new and unique merchantTranInfo shall be assigned for the transaction - `merchantOrderReference` string — The merchant assigned Oder Reference Number.

Usage Instruction
1. Evonet does not validate this value. Merchant can define this reference number to track different transactions related to the same order within merchant site.
2. Field type: String(32) - `merchantTransID` string — The merchant assigned transaction identifier, should be unique under same Store ID.

Usage Instruction
1. Field type: String(32) - `merchantTransTime` string, date-time, required — Time when merchant submits this transaction

Usage Instruction
1. Field type: Datetime
2. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD
3. Sample: 2017-07-17T13:42:40+01:00 - `webhook` string — This filed is used for merchant to provide asynchronous notification endpoint - Usage Instruction 1. Merchant may provide this information in the request message, once it is processed successfully, Evonet will send notification to this endpoint 2. The format of the webhook must contain http:// or htps:// 3. Field Type: String(300) - `initiatingReason` string — This field is used for merchant to state the reason to initiate the transaction - Usage Instruction 1. It is suggested to send this field in the process of DELETE PaymentMethod, POST Capture, POST Cancel, and POST Refund 2. For DELETE PaymentMethod request, if merchant needs to remove WeChat Pay token, this field must be presented. 3. Field Type: String(64) - `metadata` string — This field is used for merchant to state reference information - Usage Instruction 1. If merchant sends this field in the request message, Evonet will echo it back in the response 2. Field Type: String(512) ## Response `200` - object - `result` object, required — The result information for the transaction processed - Usage Instruction 1. Used in the response of PaymentMethod, Payment, Capture, Cancel and Refund - `code` string, required — This is the code of result from Evonet about the transaction processed - Value defined Refer to . - Usage Instruction 1. Field Type: String(8) - `message` string, required — This is the description about the code of result - Value defined Refer to . - Usage Instruction 1. Field Type: String(1024) - `category` 'M' | 'N' | 'E' | 'S' | 'H' | 'R' — The category of the response code. - `pspResponseCode` string — This is the Response code from the PSP. - Usage Instruction 1. If the PSP returns a response code for the transaction, Evonet will forward to merchant in this field 2. Field Type: String(1024) - `pspMessage` string — This is the Response code from the PSP. - Usage Instruction 1. If the PSP returns a response code for the transaction, Evonet will forward to merchant in this field 2. Field Type: String(1024) - `paymentMethod` object — This field includes the Payment Method information, including Payment Method selected by User for Payment, and the Payment Method supported by the merchant - `recurringReference` string — The recurringReference that uniquely identifies the recurring transaction. Merchant will needs this to make future payments for the user. - Usage Instruction 1. For POST Payment response, PUT Payment response GET Payment response, Payment Notification , POST PaymentMethod response, PUT PaymentMethod response, GET PaymentMethod response and PaymentMethod Notification, it is generated by Evonet. 2. For POST Payment request, it is present for future payments. 3. Field Type: String(64) - `paymentMethodVariant` 'GPWallet' | 'Postpaid' | 'Instalment_4' | 'Alipay' | 'TrueMoney Wallet' | 'AlipayHK' | 'TNG eWallet' | 'GCash' | 'DANA' | 'Kakao Pay' | 'Rabbit LINE Pay' | 'BPI' | 'Boost' | 'Akulaku PayLater' | 'Recurring' | 'COF' | 'Card' | 'Balance' — This is to indicate the sub Payment Method of a transaction. - Value defined The accepted values of this field, please refer to e-wallet paymentMethod type of the Appendix: Payment Method Variant - Usage Instruction 1. All values are applied in response from Evonet 2. Field Type: String(32) - `isNetworkToken` boolean — This field is used to indicate the transaction is pay by network token or not. - Usage Instruction 1. If true, means this transaction is paid by network token. 2. If not present, means default value = false 3. Field Type: Boolean - `accountUpdateIndicator` 'Y' | 'N' — Account Update Indicator - Usage Instruction 1. This field is suitable for the paymentBrand=Visa - `card` object — his field is to send card related information for this transaction -Usage Instruction: 1. For POST Payment or POST PaymentMethod. If paymentMethod.type = card, the field must be present 2. For PUT PaymentMethod. Merchant may send this field to update the card information corresponding to the token. 3. Evonet may include this object in response 4. For POST Payment or POST PaymentMethod response. If paymentMethod.type=GooglePay & The paymentMethod.encryptedData is a card that consists of PAN, the field will be present. - `first6No` string, required — The first 6 digits of the card number - Usage Instruction 1. This field is used in response from Evonet 2.For POST Payment or POST PaymentMethod response. If paymentMethod.type=GooglePay & The paymentMethod.encryptedData is a card that consists of PAN, the field will be present. 3. Field Type: String(6) - `last4No` string, required — The last 4 digits of the card number - Usage Instruction 1. This field is used in response from Evonet 2.For POST Payment or POST PaymentMethod response. If paymentMethod.type=GooglePay & The paymentMethod.encryptedData is a card that consists of PAN, the field will be present. 3. Field Type: String(4) - `paymentBrand` string — This is used to indicate the card scheme which the card belongs to - Value defined The accepted values of this field, please refer to card paymentMethod type of the Appendix 8.8 payment brands - Usage Instruction: 1. This is used in response from Evonet 2.For POST Payment or POST PaymentMethod response. If paymentMethod.type=GooglePay & The paymentMethod.encryptedData is a card that consists of PAN, the field will be present. 3. Field Type: String(32) - `fundingType` 'credit' | 'debit' | 'prepaid' — This is used to indicate the type of the card - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(32) - `holderName` string — The cardholder name - Usage Instruction 1. This field is used in the response from Evonet 2. Field Type: String(50) - `issuingBank` string — The name of Issuing Bank - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(16) - `issuingCountry` string — The card issuing country. - Usage Instruction 1. This field is used in response from Evonet 2. The three-character country code as defined in ISO-3166-1 alpha-3. For example, SGP. 3. Field Type: String(3) - `issuerCountry` string — The cardholder's country. - Usage Instruction 1. This field is used in response from Evonet 2. The three-character country code as defined in ISO-3166-1 alpha-3. For example, SGP. 3. Field Type: String(3) - `isCommercial` boolean — This is used to response whether the card is a business card. -Value defined true: this card is a business card false: this card is not a business card - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: boolean - `productID` string — The card product ID. - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(30) - `updatedCardInfo` string — The updated card information. -Usage Instruction: 1. If paymentMethod.type=card & paymentMethod.accountUpdateIndicator is not empty & Have configured ‘API Resp RSA Encryption Key' in Evonet Platform , then this field will return. And when paymentMethod.accountUpdateIndicator=Y, the cardNumber or expireDate that in this field will return. 2. The plain text sample is as follows: {""cardNumber"":""341111597242513"",""expiryDate"": ""2512"", ""accountStatus"": ""CardChanged""} -Value defined of accountStatus CardNumberChanged：The account number or account number and expiration date have changed. CardExpiryChanged:The card expiration date has changed. CloseAccount: The card has been closed. ContactCardholder：The merchant should contact the cardholder for additional information on the account. Unknown: Unknown. 3. This field is encrypted with RSA; 4. The Encryption flow is as follows: Step 1: The spliced json character string: {""cardNumber"":""341111597242513"",""expiryDate"": ""2512"", ""accountStatus"": ""CardChanged""} Step 2: Encrypt the character string using the RSA public key. Step 3: Put the cipher text into this field. - `e-wallet` object — This is used to send E-Wallet related Information for this transaction - Usage Instruction 1. For POST payment or PaymentMethod request, if paymentMethod.type = ‘e-wallet’, the field must be present 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of E-Wallet. - Value defined The accepted values of this field, please refer to e-wallet paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST PaymentMethod request: only Alipay, Alipayplus, AlipayHK, Boost, DANA, GCash, Kakao_Pay, Rabbit_LINE_Pay, TNG, TrueMoney_Wallet and WeChat_Pay are applied 2. For POST Payment request: all values are applied 3. All values are applied in response from Evonet 4. This field is optional when transInitiator.inStorePaymentScenario=CPM 5. Field Type: String(32) - `token` object — This is used to send token related Information for this transaction - Usage Instruction 1. For POST payment or PaymentMethod request, if paymentMethod.type = token, the field must be sent 2. For POST Payment or POST PaymentMethod response. If paymentMethod.type=GooglePay & The paymentMethod.encryptedData is a tokenized card that consist of device PAN and cryptograms, the field will be present. 3. Evonet may include this field in response - `value` string, required — The token value. - Usage Instruction 1. For POST Payment request, this must be sent when paymentMethod.type = token 2. For POST Payment response, this is used in response from Evonet 3. For PUT PaymentMethod and PUT Payment, this is used in response from Evonet 4. Field Type: String(64) - `expiryDate` string, date-time — This is the token expiration date and time -Usage Instruction 1. Evonet may include this field in response 2. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 3. Sample: 2017-07-17T13:42:40+01:00. 4. Field Type: Datetime - `userReference` string — The User ID obtained or assigned by merchant, and used for merchant reference - Usage Instruction 1. Evonet may include this field in response 2. The value of this field is same as userInfo.reference in your POST request. 3. Field Type: String(64) - `vaultID` string — The group ID which the token belongs to. This token is unique under same vault ID - Usage Instruction: 1. This ID is assigned in Evonet, and will be provided to customer before integration. 2. Evonet may include this field in response 3. Field Type: String(36) - `fingerprint` string — The token's fingerprint. - Usage Instruction 1. Evonet may include this field in response 2. Field Type: String(64) - `createTime` string, date-time — The token's created datetime.-Usage Instruction1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00.3. Evonet may include this field in response4. Field Type: Datetime - `updateTime` string, date-time — The token's last updated datetime.-Usage Instruction1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00.3. Evonet may include this field in response4. Field Type: Datetime - `status` 'disabled' | 'enabled' | 'expired' — The status of token - Usage Instruction 1. Evonet may include this field in response. But when paymentMethod.token.type=networkToken, it is not present in response. 2. Field Type: String(20) - `first6No` string — The first 6 digits of the tokenized cards that consist of device PAN. - Usage Instruction 1. For POST Payment or POST PaymentMethod response. If paymentMethod.type = Google Pay&paymentMethod.GooglePay.tokenize=true&The paymentMethod.encryptedData is a tokenized card that consist of device PAN and cryptograms, the field will be present. 2. Field Type: String(6). - `last4No` string — The last 4 digits of the tokenized cards consist of device PAN. - Usage Instruction 1. For POST Payment or POST PaymentMethod response. If paymentMethod.type = Google Pay&paymentMethod.GooglePay.tokenize=true&The paymentMethod.encryptedData is a tokenized card that consist of device PAN and cryptograms, the field will be present. 2. Field Type: String(4). - `networkToken` object — This object is used to send network token related Information for this transaction - Usage Instruction 1. For POST PaymentMethod response, if the request generated a network token, the field will be present. - `status` 'enabled' | 'suspended' | 'disable', required — The status of Network Token - Usage Instruction 1. Field Type: String(32) - `supportDeviceBinding` boolean, required — Does current network token support device binding? - Value definition true: support false: unsupport -Uasge Instruction If current network token support device binding, you can use PUT PaymentMethod to continue the binding. - `tokenID` string, required — The unique ID of the network token assigned by card scheme - Usage Instruction 1. Evonet may include this field in response. 2. Field Type: String(64) - `first6No` string, required — The first 6 digits of the network token - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(6) - `last4No` string, required — The last 4 digits of the network token - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(4) - `expiryDate` string, required — The expiration date of the network token -Usage Instruction 1. Format: MMYY - `paymentAccountReference` string — Payment Account Reference (PAR) if available for this payment instrument. - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(64) - `tokenReferenceID` string — It is a unique ID associated with a single token. - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(64) - `tokenRequesterID` string — The TRID (Token requester ID) assigned by card scheme. - Usage instruction: 1. When the transaction is used network token and card scheme return this ID, Evonet will return. - `points` object — This field is to send points payment related information for this transaction -Usage Instruction: 1. For POST Payment. If paymentMethod.type = points, the field must be present 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of points payment. - Value defined The accepted values of this field, please refer to points paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `onlineBanking` object — This field is to send online banking payment related information for this transaction -Usage Instruction: 1. For POST Payment. If paymentMethod.type = onlineBanking, the field must be present 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of online banking. - Value defined The accepted values of this field, please refer to onlineBanking paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `issuingCompany` string — The name of Issuing Bank. This information can be included when available. - Usage Instruction 1. This field is used in response from Evonet 2. Field Type: String(128) - `bankTransfer` object — This field is to send virtual account or payment voucher of payment related information for this transaction -Usage Instruction: 1. For POST Payment. If paymentMethod.type = bankTransfer, the field must be present 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of virtual account. - Value defined The accepted values of this field, please refer to bankTransfer paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `accountNumber` string — This is to indicate the account number of virtual account. - Usage Instruction 1. This is used in response from Evonet 3. Field Type: String(32) - `buyNowPayLater` object — This field is to send Buy Now Pay Later payment related information for this transaction -Usage Instruction: 1. For POST Payment. If paymentMethod.type = bankTransfer, the field must be present 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of Buy Now Pay Later. - Value defined The accepted values of this field, please refer to buyNowPayLater paymentMethod type of the Appendix Payment Methods -Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `carrierBilling` object — This field is to send carrier billing payment related information for this transaction -Usage Instruction: 1. For POST Payment. If paymentMethod.type = carrierBilling, the field must be presented. 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand who are support for carrier billing. - Value defined The accepted values of this field, please refer to carrierBilling paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST Payment request: all values are applied. 2. All values are applied in response from Evonet. 3. Field Type: String(32) - `prepaidCard` object — This field is to send prepaid card related information for this transaction. -Usage Instruction: 1. For POST Payment. If paymentMethod.type = prepaidCard, the field must be presented. 2. Evonet may include this object in response - `paymentBrand` 'WebMoney' | 'Net_Cash' | 'BitCash', required — This is to indicate the payment brand of prepaid card. - Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `cash` object — This field is to send konbini (convenience store) payment related information for this transaction. -Usage Instruction: 1. For POST Payment. If paymentMethod.type = cash, the field must be presented. 2. Evonet may include this object in response - `paymentBrand` string, required — This is to indicate the payment brand of cash-based payment. - Value defined The accepted values of this field, please refer to cash paymentMethod type of the Appendix Payment Methods - Usage Instruction 1. For POST Payment request: all values are applied 2. All values are applied in response from Evonet 3. Field Type: String(32) - `payment` object — This object includes related information for an original Payment transaction which has been successfully processed in Evonet

Usage Instruction
1. This field is used in response for the API of Payment, Cancel, Capture, Refund and DataSubmission
2. This field is used in Notification for the API of Payment, Cancel, Capture and Refund and DataSubmission
- `status` 'identify_pending' | 'identified' | 'identify_declined' | 'verify_pending' | 'verified' | 'verify_declined' | 'auth_pending' | 'declined' | 'authorized' | 'capture_pending' | 'captured' | 'cancel_pending' | 'cancelled' | 'refund_pending' | 'refunded_partial' | 'refunded_full', required — The status of Original Payment transaction

Value defined:
verify_pending: Used for Card transaction authentication, means authentication is in processing.
verified: Used for Authentication only transaction, means the authentication is successfully completed.
auth_pending: For E-Wallet transaction, means transaction is waiting to pay. For card transaction, means authorization is in progress (merchant can submit query, or Cancel).
authorized: used for card transaction, means the transaction authorization is successfully completed and pending for Capture (merchant can submit cancel).
cancel_pending: Means Evonet received and processed the cancel, but pending for PSP confirmation.
cancelled: Means Evonet received and processed the cancel, and also, completed the cancel with PSP successfully.
captured_pending: Used for Card transaction, means the capture is in processing.
captured: If card transaction, means transaction authorization and capture are successfully completed; If E-Wallet transaction, means transaction is successfully completed.
refund_pending: Means the refunding for this transaction is in processing.
refunded_full: Means the transaction is refunded in full successfully.
refunded_partial: means the transaction is refunded in partial successfully.
declined: Used for both card and E-Wallet transaction, means transaction is failed

Usage Instruction
1. Field Type: String(20)
- `failureCode` string — Error code returned for the payment. - Value defined Refer to . - Usage Instruction 1. Only returned when the payment.status=declined 2. Field Type: String(8) - `failureReason` string — Error message returned for the payment. - Value defined Refer to . - Usage Instruction 1. Only returned when the payment.status=declined 2. Field Type: String(1024) - `merchantTransInfo` object, required — This is the information of merchantTransInfo from the request of the initial Payment transaction - `merchantTransID` string, required — This is the merchantTransID from the initial Payment transaction - Usage Instruction 1. Field Type: String(32) - `merchantOrderReference` string — This is the merchantOrderReference from the initial Payment transaction - Usage Instruction 1. Field Type: String(32) - `merchantTransTime` string, date-time, required — This is the merchantTransTime from the initial Payment transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 - `evoTransInfo` object — This is the evoTransInfo for the initial Payment transaction - Usage Instruction 1. This is generated by Evonet - `evoTransID` string, required — This is the evoTransID for the initial Payment transaction - Usage Instruction 1. Field Type: String(32) 2. This is generated by Evonet - `evoTransTime` string, date-time, required — This is the evoTransTime for the initial Payment transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 3. This is generated by Evonet - `traceNum` string — This is traceNum for the initial Payment transaction - Usage Instruction 1. Field Type: String(6) 2. This is provided by Evonet if existed when sending transaction to PSP - `retrievalReferenceNum` string — This is the retrievalReferenceNum for the initial Payment transaction - Usage Instruction 1. Field Type: String(12) 2. This is provided by Evonet if existed when sending transaction to PSP - `pspTransInfo` object — This is the pspTransInfo for the initial Payment transaction - Usage Instruction 1. Evonet may provide this if PSP responses the related information - `pspTransID` string — This is the pspTransID for the initial Payment transaction - Usage Instruction 1. Field Type: String(64) 2. Evonet may provide it if PSP responses this information - `pspTransTime` string, date-time — This is the pspTransTime for the initial Payment transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 3. Evonet may provide it if PSP responses this information - `authorizationCode` string — This is the authorizationCode for the initial Payment transaction - Usage Instruction 1. Field Type: String(6) - `cvcCheckResultRaw` string — This is the cvc check raw result for the initial payment transaction - Usage Instruction 1. Field Type: String(3) 2. Evonet may provide it if PSP responds to this information - `cvcCheckResult` string — This is the cvc check result for the initial payment transaction - Value defined: M: Indicate cvc match N: Indicate cvc no match P: Indicate cvc not process, the card scheme or issuer was unable to verify the cvc value S: Indicate cvc should be on the card, because the card scheme or issuer wants to perform cvc verification U: Indicate cvc unverified, because issuer does not participate in cvc service - Usage Instruction 1. Field Type: String(1) - `retrievalReferenceNum` string — This is the retrievalReferenceNum for the initial Payment transaction - Usage Instruction 1. Field Type: String(64) 2. Evonet may provide it if PSP returns the information - `avsCheckResultRaw` string — AVS raw result for the initial payment transaction.

Usage Instruction

Field Type: String(1)
Evonet may provide it if PSP responds with this information. - `avsCheckResult` 'Y' | 'A' | 'Z' | 'N' | 'R' | 'U' — AVS check result after internal standardization and mapping based on avsResultRaw.

Usage Instruction

Field Type: String(1)
Evonet may provide it if PSP responds with AVS information and internal mapping is applicable. - `transAmount` object, required — This is the transAmount for the initial Payment transaction - Usage Instruction 1. This is from the request message of merchant - `currency` string, required — This is the transAmount.currency for the initial Payment transaction - Usage Instruction 1. Field Type: String(3) 2. Same with the information in request message - `value` string, required — This is the transAmount.value for the initial Payment transaction - Usage Instruction 1. Field Type: String(12) 2. Same with the information in request message - `localAmount` object — This is used to define the amount of the transaction in merchant local currency. The filed “value” in this object must same as the initial POST FXRateInquiry interface. - Usage Instruction 1. This object is mandatory when you need use Acquirer- MCP service. 2. Used in POST Payment request, to send the payment transaction amount in local currency. - `currency` string, required — The currency for this transaction. - Value defined The three-character currency code as defined in ISO-4217. For example : HKD - Usage Instruction: 1. Field Type: String(3) - `value` string, required — The value of the transaction amount with major unit -Usage Instruction 1. Example：if currency=HKD, 12.34 means 12.34 HKD, 30 means 30.00HKD; if currency=JPY, 1234 means 1234 JPY 2. Field Type: String(12). - `billingAmount` object — The user billing amount for the initial Payment transaction - Usage Instruction 1. Evonet may provide this information if PSP returns - `currency` string, required — The user billingAmount.currency for the initial Payment transaction - Usage Instruction 1. Evonet may provide this information if PSP returns 2. Field Type: String(3) - `value` string, required — The user billingAmount.value for the initial Payment transaction - Usage Instruction 1. Evonet may provide this information if PSP returns 2. Example: If currency=HKD, 12.34 means 12.34 HKD; if currency=JPY, 1234 means 1234 JPY 3. Field Type: String(12) - `billingFXRate` object — The FX rate between transaction currency and user billing currency- Usage defined:1. Evonet may provide this information if PSP returns - `value` string, required — The value of FX rate - Usage Instruction 1. Evonet may provide this information if PSP returns 2. Example: If 1 HKD = 14.485206 JPY, this value is 1/14.485206=0.0690360 3. Field Type: String(24) - `baseCurrency` string, required — Code of Base currency (transaction currency) - Usage Instruction 1. Evonet may provide this information if PSP returns 2. Field Type: String(3) - `quoteCurrency` string, required — Code of the billing currency - Usage Instruction 1. Evonet may provide this information if PSP returns 2. Field Type: String(3) - `convertTransAmount` object — This is the amount calculated for the merchant based on the original transaction currency and amount, when the merchant needs to send out transaction in different currency and has different settlement currency - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion - `currency` string, required — Code of Currency after conversion - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Field Type: String(3) - `value` string, required — Amount after currency conversion - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Example: If 1 HKD = 14.485206 JPY, this value is 1/14.485206=0.0690360 3. Field Type: String(12) - `convertTransFXRate` object — FX rate between the transaction currency and merchant convert currency- Usage Instruction1. Evonet may provide this information when the merchant supports currency conversion2. This FX rate is from Evonet - `value` string, required — Exchange rate value, The value of FX rate - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Example: If 1 HKD = 14.485206 JPY, this value is 1/14.485206=0.0690360 3. Field Type: String(24) - `baseCurrency` string, required — Code of transaction currency - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Field Type: String(3) - `quoteCurrency` string, required — Code of merchant Convert currency - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Field Type: String(3) - `source` string — The source of the exchange rate source - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Field Type: String(32) - `date` string — Date for the exchange processing - Usage Instruction 1. Evonet may provide this information when the merchant supports currency conversion 2. Format: YYYYMMDD 3. Field Type: String(8) - `cancel` object — This is the related information for the Cancel transaction processed - Usage Instruction 1. used in the response of POST cancel - `status` 'Success' | 'Received' | 'Failed', required — This is the status for the Cancel request - Usage Instruction 1. Field Type: String(20) - `failureCode` string — Error code returned for the cancel. - Value defined Refer to . - Usage Instruction 1. Only returned when the cancel.status=declined 2. Field Type: String(8) - `failureReason` string — Error message returned for the cancel. - Value defined Refer to . - Usage Instruction 1. Only returned when the cancel.status=declined 2. Field Type: String(1024) - `merchantTransInfo` object, required — This is the information of merchantTransInfo from the request of the initial Cancel transaction - `merchantTransID` string, required — This is the merchantTransID from the initial Cancel transaction - Usage Instruction 1. Field Type: String(32) - `merchantOrderReference` string — This is the merchantOrderReference from the initial Cancel transaction - Usage Instruction 1. Field Type: String(32) - `merchantTransTime` string, date-time, required — The merchantTransTime from the initial Cancel transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 - `evoTransInfo` object — This is the evoTransInfo for the initial Cancel transaction - Usage Instruction 1. This is generated by Evonet - `evoTransID` string, required — This is the evoTransID for the initial Cancel transaction - Usage Instruction 1. Field Type: String(32) 2. This is generated by Evonet - `evoTransTime` string, date-time, required — This is the evoTransTime for the initial Cancel transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 3. This is generated by Evonet - `traceNum` string — This is traceNum for the initial Cancel transaction - Usage Instruction 1. This is provided by Evonet if existed when sending transaction to PSP - `retrievalReferenceNum` string — This is the retrievalReferenceNum for the initial Cancel transaction - Usage Instruction 1. This is provided by Evonet if existed when sending transaction to PSP - `pspTransInfo` object — This is the pspTransInfo for the initial Cancel transaction - Usage Instruction 1. Evonet may provide this if PSP responses the related information - `pspTransID` string — This is the pspTransID for the initial Capture transaction - Usage Instruction 1. Field Type: String(64) 2. Evonet may provide it if PSP responses this information - `pspTransTime` string, date-time — This is the pspTransTime for the initial Capture transaction - Usage Instruction 1. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD 2. Sample: 2017-07-17T13:42:40+01:00 3. Evonet may provide it if PSP responses this information - `retrievalReferenceNum` string — This is the retrievalReferenceNum for the initial Cancel or CancelorRefund transaction - Usage Instruction 1. Field Type: String(64) 2. Evonet may provide it if PSP returns the information - `metadata` string — This field is used for merchant to state reference information - Usage Instruction 1. If merchant sends this field in the request message, Evonet will echo it back in the response 2. Field Type: String(512) --- [API](https://skmtc.net/evonetonline/apis/evonet-api.md) · [All operations](https://skmtc.net/evonetonline/apis/evonet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/evonetonline/evonet-api/revisions/2136e26ceb19/schema)