--- title: "interaction" method: GET path: "/interaction/{merchantOrderID}" tags: ["interaction"] --- # interaction `GET /interaction/{merchantOrderID}` ## Path parameters - `merchantOrderID` string, required ## Headers - `Authorization` string, required - `Content-type` string, required - `DateTime` string, required - `KeyID` string, required - `MsgID` string - `SignType` string, required ## Request body - object ## Response `200` - object - `result` object, required - `code` string, required — All supported Result Codes refer to the Appendix Result Codes. - `message` string, required — The result detail. - `category` 'M' | 'N' | 'E' | 'S' | 'H' | 'R' — The category of the response code. - `merchantOrderInfo` object — Merchant order information object - `merchantOrderID` string, required — The unique Drop-in order ID generated by the merchant. Same as in the Drop-in request. - `status` 'Paid' | 'Closed' | 'Pending', required — Indicate the status of Drop-in order. - `transactionInfo` object — Transaction information object - `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 - `merchantTransInfo` object, required — Merchant transaction information object - `merchantTransID` string, required — The transaction ID created by Evonet. The merchant can use it to query refund API to refund. - `merchantOrderReference` string - `merchantTransTime` string, date-time, required — The transaction time submitted. Format: RFC3339. Return when the status is “Paid”. For example: 2006-01-02T15:04:05+07:00 - `evoTransInfo` object — Evonet transaction information object - `evoTransID` string, required — The internal transaction ID of Evonet. - `evoTransTime` string, required — The internal transaction time of Evonet - `traceNum` string — The system trace number which will be notified in card transaction. - `retrievalReferenceNum` string — The system trace number which will be notified in card transaction. - `pspTransInfo` object — PSP transaction information object - `pspTransID` string — Notify when the PSP provides this parameter. - `authorizationCode` string — The authorization code which will be returned in card transaction. - `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 — Transaction amount object Same as in the Drop-in request. - `currency` string, required — The three-character currency code as defined in ISO-4217. For example: CNY - `value` string, required — The amount with a major unit. For example: 123.45 - `billingAmount` object — user billing amount object Return when PSP responds. - `currency` string, required — The three-character currency code as defined in ISO-4217. For example: SGD - `value` string, required — The amount with a major unit. For example: 24.68 - `billingFXRate` object — The billing FX rate object between transaction amount to billing amount - `value` string, required — The FX rate value with decimal. For example: 0.2011541 - `baseCurrency` string, required — The currency of the transAmount. The three-character currency code as defined in ISO-4217. For example: CNY - `quoteCurrency` string, required — The currency of the billingAmount. The three-character currency code as defined in ISO-4217. For example: SGD - `source` string — The source of the FX rate. For example: JCB - `date` string — The date of the FX rate with the format YYYYMMDD. For example: 20200518 - `convertTransAmount` object — Reserved - `currency` string, required — Reserved - `value` string, required — Reserved - `convertTransFXRate` object — Reserved - `value` string, required — Reserved - `baseCurrency` string, required — Reserved - `quoteCurrency` string, required — Reserved - `source` string — Reserved - `date` string — Reserved - `paymentMethod` object — Payment method object - `type` string, required — The payment method type that the user uses. Possible values are shown as below: “card”, “e-wallet”, “points”, “onlineBanking”, “bankTransfer”, “buyNowPayLater”, “carrierBilling”, “cash”, “prepaidCard”. - `paymentMethodVariant` string — This is to indicate the sub Payment Method of a transaction. - Value defined Refer to Appendix Payment Methods Variant - Usage Instruction 1. All values are applied in response from Evonet 2. Field Type: String(32) - `issuingCountry` string — The country of payment method. Follow the standard of ISO-3166-1 alpha-3. - `cardInfo` object — Card information object Returned when paymentMethod.type=card - `first6No` string, required — The first 6 digits of the card number to be returned when pay by card. - `last4No` string, required — The last 4 digits of the card number to be returned when pay by card. - `paymentBrand` string — This is to indicate the payment brand of Card. - Value defined Refer to the paymentBrands corresponding to Card” in Appendix Payment Methods. - `fundingType` string — The funding type “credit”, “debit”, “prepaid” - `holderName` string — The name of the cardholder. - `issuingBank` string — The name of the issuing bank. - `isCommercial` boolean — Indicate whether it is a commercial card. - `token` object — This is used to send token related Information for this transaction - `value` string, required — The token value - `expiryDate` string, date-time — This is the token expiration date and time - `userReference` string — The User ID obtained or assigned by merchant, and used for merchant reference - `vaultID` string — The group ID which the token belongs to. This token is unique under same vault ID - `fingerprint` string — The token's fingerprint. - `createTime` string, date-time — The token's created Datetime. - `updateTime` string, date-time — The token's last updated Datetime. - `status` 'enabled' | 'expired' | 'disabled' — The status of token - `e-walletInfo` object — E-wallet information object Returned when paymentMethod.type=e-wallet - `paymentBrand` string — This is to indicate the payment brand of E-wallet. - Value defined Refer to the paymentBrands corresponding to "e-Wallet” in Appendix Payment Methods. - `consumerId` string — The user’s e-wallet account ID. - `consumerAccount` string — The user’s e-wallet account name. - `onlineBankingInfo` object — Online Banking information object Returned when paymentMethod.type=onlineBanking - `paymentBrand` string — This is to indicate the payment brand of Online Banking. - Value defined Refer to the paymentBrands corresponding to “onlineBanking” in Appendix Payment Methods. - `pointsInfo` object — Points information object Returned when paymentMethod.type=points - `paymentBrand` string — This is to indicate the payment brand of Points. - Value defined Refer to the paymentBrands corresponding to “points” in Appendix Payment Methods. - `bankTransferInfo` object — Bank Transfer information object Returned when paymentMethod.type=bankTransfer. - `paymentBrand` string — This is to indicate the payment brand of Bank Transfer. - Value defined Refer to the paymentBrands corresponding to “bankTransfer” in Appendix Payment Methods. - `accountNumber` string — This is to indicate the account number of debit account. - `buyNowPayLaterInfo` object — Buy Now Pay Later information object Returned when paymentMethod.type=buyNowPayLater. - `paymentBrand` string — This is to indicate the payment brand of Buy Now Pay Later. - Value defined Refer to the paymentBrands corresponding to “buyNowPayLater” in Appendix Payment Methods. - `carrierBillingInfo` object — Carrier Billing information object Returned when paymentMethod.type=carrierBilling. - `paymentBrand` string — This is to indicate the payment brand of Carrier Billing. - Value defined Refer to the paymentBrands corresponding to “carrierbilling” in Appendix Payment Methods. - `cashInfo` object — Cash information object Returned when paymentMethod.type=cash. - `paymentBrand` string — This is to indicate the payment brand of Cash. - Value defined Refer to the paymentBrands corresponding to “cash” in Appendix Payment Methods. - `prepaidCardInfo` object — Prepaid Card information object Returned when paymentMethod.type=prepaidCard. - `paymentBrand` string — This is to indicate the payment brand of Prepaid Card. - Value defined Refer to the paymentBrands corresponding to “prepaidCard” in Appendix Payment Methods. - `transInitiator` object — User's device information, will be returned when drop-in can obtain them. - `platform` 'WEB' | 'WAP' | 'APP' | 'MINI' | 'INWALLET' — The type of terminal platform - `deviceType` 'Android' | 'iOS' — The terminal type - `deviceID` string — The ID of the client device. - `userCreateIP` string — The IP address of the terminal where the user initiates the transaction - `userInfo` object — After the user submits their information, Evoent will redirect them back to the merchant. - `email` string — User's email address, if merchant send this field, Drop-in will display it on drop-in interface.

Usage Instruction:
1. When merchantOrderInfo.isCollectEmail = true, this field will be ignored. - `mobilePhone` object — The mobile phone number provided by the Cardholder. If merchant send this field, Drop-in will display it on drop-in interface.

Usage Instruction:
1. Refer to ITU-E.164 for additional information on format and length.
2. When merchantOrderInfo.isCollectPhoneNumber = true, this field will be ignored. - `countryCode` string, required — The country code sections of the mobilePhone. - `subscriberSections` string, required — he subscribe sections of the mobilePhone. - `deliveryAddress` object — Delivery (Shipping) Address. If merchant send this field, Drop-in will display it on drop-in interface.

Usage Instruction:
1. When merchantOrderInfo.isCollectShippingAddress = true, this field will be ignored. - `country` string, required — Country of the shipping address requested by the Cardholder.

Usage Instruction:
1. Defined in ISO-3166-1 alpha-3. For example, HKG. - `addressLine1` string — First line of the street address or equivalent local portion of the shipping address requested by the Cardholder. - `addressLine2` string — The second line of the street address or equivalent local portion of the shipping address requested by the Cardholder. - `postalCode` string, required — The ZIP or other postal code of the shipping address requested by the Cardholder. - `billingAddress` object — Billing Address. If merchant send this field, Drop-in will display it on drop-in interface.

Usage Instruction:
1. When merchantOrderInfo.isCollectBillingAddress = true, this field will be ignored. - `country` string, required — Country of the billing address requested by the Cardholder.

Usage Instruction:
1. Defined in ISO-3166-1 alpha-3. For example, HKG. - `addressLine1` string — First line of the street address or equivalent local portion of the shipping address requested by the Cardholder. - `addressLine2` string — The second line of the street address or equivalent local portion of the shipping address requested by the Cardholder. - `postalCode` string, required — The ZIP or other postal code of the shipping address requested by the Cardholder. --- [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/versions/2136e26ceb19/schema)