---
title: "interaction"
method: POST
path: "/interaction"
tags: ["interaction"]
---

# interaction

`POST /interaction`

## Headers

- `Authorization` string, required
- `Content-type` string, required
- `DateTime` string, required
- `KeyID` string, required
- `MsgID` string
- `SignType` string, required

## Request body

- object
  - `merchantOrderInfo` object, required — Order information object
    - `merchantOrderID` string, required — The unique order ID generated by the merchant for Drop-in. After the payment succeeds, the merchant can use this field to match the original Drop-in order in notification message or retrieve the Drop-in order. Alphabetic and numeric characters are accepted.
    - `merchantOrderTime` string, date-time, required — Time when the order is created, submitted by the merchant. Format: RFC3339. For example: 2006-01-02T15:04:05+07:00.
    - `isCollectEmail` boolean — Whether Drop-in front-end page needs to collect the user's email. Default false.
    - `isCollectPhoneNumber` boolean — Whether Drop-in front-end page needs to collect the user's name and phone number. Default false.
    - `isCollectBillingAddress` boolean — Whether Drop-in front-end page needs to collect the user's billing address information. Default false.
    - `isCollectShippingAddress` boolean — Whether Drop-in front-end page needs to collect the user's shipping address information. Default false.
  - `validTime` number — The valid time of LinkPay/Drop-in order.<br> The Payment Link will expire after 5~43200 minutes (maximum 30 days).<br> The accepted value is 5 to 43200.<br> The unit is minute.<br> Default value: 60 minutes.<br>
  - `returnUrl` string — The URL used for redirection after the payment is completed.<br> For example: HTTPs://www.merchantweb.com<br> Evonet will add the merchantOrderID and result of the payment after the URL.<br> Currently the page will only get redirected after the order has been paid, so the result is fixed as success.<br> For example: HTTPs://www.merchantweb.com?merchantOrderID=123123123123&result=success
  - `webhook` string — The webhook URL provided by merchant host to receive the payment result notification after the order has been paid.
  - `transAmount` object, required — Transaction amount object
    - `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
  - `userInfo` object, required — userInfo Object
    - `reference` string, required — The User ID obtained or assigned by merchant, and used for merchant reference.<br> This field is mandatory when Evonet needs to generate token, which is as the reference for the token.<br> The group ID which the token belongs to.<br> This token is unique under same vault ID.
    - `vaultID` string — This ID is assigned in Evonet, and will be provided to customer before integration.<br> This field is optional when Evonet needs to generate token, which is as the reference for the token.
    - `email` string, required — User's email address, if merchant send this field, Drop-in will display it on drop-in interface.<br> - Usage Instruction:<br> 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 — The 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 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.
      - `stateOrProvince` string — The state or province of the shipping address associated with the card being used for this purchase.<br> Value defined<br> The accepted values of this field, please refer to ISO Alpha Country subdivision Code of the Appendix State and Province Code<br> Usage Instruction: <br> 1. Should be the country subdivision code defined in ISO 3166-2. <br> 2. For example, using the ISO entry US-CA (California, United States), the correct value for this field = CA. Note that the country and hyphen are not included in this value.
  - `paymentMethod` object
    - `recurringProcessingModel` 'Subscription' | 'Unscheduled' — This is to indicate whether a transaction is recurring or COF transaction. This field only available when userInfo.reference provide.
  - `allowAvsCheck` boolean — This is to indicate if an AVS (Address Verification Service) check should be performed<br><br>Usage Instruction<br><br>1. This field is used in POST Payment requests only. If true, Evonet will perform an AVS check for the card transaction.<br><br>2. If not present, default value = false, Evonet will skip AVS check.<br><br>3. Field Type: Boolean (true / false)
  - `tradeInfo` object — Trade information object.
    - `tradeType` 'Hotel' | 'Airline' | 'Sale of goods' | 'Others' — The trade type, below 4 types are supported:<br><br>"Hotel", "Airline", "Sale of goods", "Others"
    - `hotelName` string — Mandatory when the tradeType is Hotel.<br><br>Field Type: String(128)
    - `checkInTime` string, date-time — The check-in time submitted by the merchant.<br><br>Fotmat: RFC3339. <br><br>Mandatory when the tradeType is Hotel.<br><br>For example: 2006-01-02T15:04:05+07:00
    - `checkOutTime` string, date-time — The check-out time submitted by the merchant.<br><br>Fotmat: RFC3339.<br><br>Mandatory when the tradeType is Hotel.<br><br>For example: 2006-01-02T15:04:05+07:00
    - `fightNumber` string — Mandatory when the tradeType is Airline. If multiple parameters are sent, separate them with commas.<br><br>For example: CZ689, MU5910<br><br>Field Type: String(30)
    - `departureTime` string, date-time — The departure time submitted by the merchant.<br><br>Format: RFC3339.
    - `goodsName` string — The name of the goods.<br><br>Mandatory when the tradeType is Sale of goods.<br><br>For example: iPhone 17<br><br>Field Type: String(128)
    - `goodsDescription` string — The description of the order to be shown on the LinkPay Payment Page. If multiple parameters are sent, separate them with commas.<br><br>Mandatory when the tradeType is Sale of goods.<br><br>For example: iPhone 17 512G<br><br>Field Type: String(256)
    - `totalQuantity` number — The total quantities of all goods in one order.<br><br>For example: 1<br><br>Field Type: Number(10)

## 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.
  - `expiryTime` string, date-time — The expiry date and time for the Payment Link. Format: RFC3339. Returned when the result is successful. For example: 2020-04-11T15:04:05+07:00
  - `merchantOrderInfo` object — Merchant order information object. Return when the request is successful.
    - `merchantOrderID` string, required — Same as request.
    - `status` 'Failed' | 'Pending', required — Indicate the status of Drop-in order. Possible values are as shown below: “Failed”, “Pending”
  - `transAmount` object — The transaction amount object. Return when the request is successful.
    - `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.
  - `linkUrl` string — The URL of Drop-in Payment Page. Return when the request is successful.
  - `sessionID` string — The session ID to invoke Drop-in. Return when the request is successful.

---

[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)