Sign in

v1

latestOpenAPI 3.0.02026-07-24130633.0 KB
interaction

interaction

post/interaction

Headers

Authorizationstring required

Sign key assigned by Evonet.

Content-typestring required

Specify application/json; charset=utf-8, which means the message body of the request and response must be in the JSON format, and the character encoding is UTF-8. It will be echoed back in the response message.

DateTimestring required

The time when the message is sent. The format follows ISO 8601, which is YYYY-MMDDThh:mm:ssTZD. For example, 2021-05-26T10:08:25+08:00. It will be echoed back in the response message.

KeyIDstring required

KeyID is a unique key identifier of up to 36 characters that is generated along with the signature key by Evonet.

MsgIDstring

An ID for a merchant to trace every API request.<br> The suggested value is UUID or GUID, such as 2d21a5715c034efb7e0aa383b885fc7a.<br> It is suggested to specify this value with no more than 32 characters in length.<br> Evonet will not validate this value and will echo it back in the response message.

SignTypestring required

Fixed value: Key-based.

Request body

validTimenumber

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>

returnUrlstring

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

webhookstring

The webhook URL provided by merchant host to receive the payment result notification after the order has been paid.

allowAvsCheckboolean

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)

Response

expiryTimestring 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

linkUrlstring

The URL of Drop-in Payment Page. Return when the request is successful.

sessionIDstring

The session ID to invoke Drop-in. Return when the request is successful.

All 13 operations