Payment

Request

Path Parameters

sid

string

Required

Header Parameters

Authorization

string

Required

signature value

Content-type

string

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.

DateTime

string

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.

KeyID

string

KeyID is a unique key identifier of up to 32 characters that is generated along with the signature key, and is only mandatory if the store is configured to use multi-level keys instead of just using store-level key.

MsgID

string

Required

An ID for a merchant to trace every API request. The suggested value is UUID or GUID, such as 2d21a5715c034efb7e0aa383b885fc7a. It is suggested to specify this value with no more than 32 characters in length. EVO Cloud will not validate this value and will echo it back in the response message. - Usage Instruction 1. Field Type: String(1024)

SignType

string

Required

SHA256, SHA512, HMAC-SHA256, HMAC-SHA512 The method of the message being signed. It can be SHA256, SHA512, HMAC-SHA256 or HMAC-SHA512.

Idempotency-Key

string

Request idempotent identity, no more than 64 characters.

Query Parameters

merchantTransID

string<= 32 characters

The merchantTransInfo.merchantTransID of the initial request. - Usage Instruction 1. For POST Capture, Refund, Cancel, CancelOrRefund and DataSubmission. This field is the merchantTransInfo.merchantTransID of the initial Payment Request. 2. For PUT and GET request. This field is the merchantTransInfo.merchantTransID of the initial POST request. 3. For POST Payment. This field is the merchantTransInfo.merchantTransID of the initial FXRateInquiry Request. 4. Field type: String(32)

Request Body schema

allowAuthentication

boolean

This is to indicate if this Payment or Payment Method needs to conduct authentication - Usage instruction: 1. In EVO Cloud, each merchant is configured with Non-Authentication, Optional-Authentication and Must-Authentication. When store is configured Optional-Authentication, this field is applied. 2. This filed is used in POST Payment request and Payment Method request, if true, EVO cloud will conduct additional authentication for this transaction or tokenize. 3. If not present, means default value=false, EVO Cloud will not conduct authentication process for this transaction 4. Only used when paymentMethod.type=card 5. In Payment request, when paymentMethod.type=card and authenticationOnly=true this field is not applied. 6. Field Type: boolean

allowAvsCheck

boolean

This is to indicate if an AVS (Address Verification Service) check should be performed - Usage Instruction 1. This field is used in POST Payment requests only. If true, EVO Cloud will perform an AVS check for the card transaction. 2. If not present, default value = false, EVO Cloud will skip AVS check. 3. Field Type: Boolean (true / false)

authentication

object

The information used for User authentication with Card - Usage Instruction 1. EVO Cloud supports securePlue and threeDS authentication types

authenticationOnly

boolean

This is to indicate if this is an authentication only Payment request Usage definition: 1. This field is used in POST Payment request only. If true, EVO Cloud will conduct authentication only without authorization followed. 2. if not present, means default value = false, EVO Cloud will conduct authorization process after authentication. 3. Only used when paymentMethod.type=card 4. When paymentMethod.type=card and paymentMethod.card.tokenize=true this field is not applied. 5. Field Type: boolean

captureAfterHours

string<= 3 characters

Enum: 01-168not present

The number of hours for EVO Cloud to initiate Capture on behalf of merchant after successful Payment - Usage Instruction 1. This field applies for below of paymentMethod.type, including card and token. 2. It is recommended to select '0' to choose EVO Cloud capture on behalf service, unless some special merchant scenarios. 3. If paymentMethod.type≠card or token(card), this field will be ignored. 4. Field Type: String(3)

enhanceMonitoring

boolean

This is to indicate if this Payment needs to trigger monitoring - Usage instruction: 1. This filed is used in POST Payment request request, if true, EVO cloud will trigger monitoring for this transaction. 2. If not present, means default value=false, EVO Cloud will not trigger monitoring for this transaction. 3. Field Type: Boolean

extendAuthorizationDateIndicator

string<= 1 characters

Enum: Y

Extend Authorization Date Indicator - Usage Instruction 1. This field is suitable for the paymentBrand=Visa

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.

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, CancelOrRefund, DataSubmission and Cryptogram and DeviceBinding, a new and unique merchantTranInfo shall be assigned for the transaction"

metadata

string<= 512 characters

This field is used for merchant to state reference information - Usage Instruction 1. If merchant sends this field in the request message, EVO Cloud will echo it back in the response 2. Field Type: String(512)

paymentMethod

object

Required

This field includes the Payment Method information, including Payment Method selected by User for Payment, and the Payment Method supported by the merchant

recipientInfo

object

In funding transfer transaction, this object is used to send recipient information.

returnURL

string<= 300 characters

This is the URL address provided by merchant. After completing the authentication or payment processing, the user is redirected back to the merchant site. This URL address specifies which merchant site page the user goes back to. - Usage Instruction 1. Required in POST PaymentMethod or POST Payment request message when 3DS authentication is being performed. 2. Required in POST PaymentMethod request message when performing the tokenization with Alipay. 3. Required in POST Payment request message when performing the payment with E-Wallets, points and onlineBanking including 3.1 Alipay, Alipay+ and Jkopay on PC WEB, 3.2 Alipay, Alipay+, Alipay HK, WeChat Pay and Jkopay on Mobile WAP, 3.3 WeChat Pay in Official Account, 3.4 SecurePay for UnionPay, TrueMoney Wallet, Rabbit LINE Pay, Pay with Points, Krungsri Online, Bualuang iBanking, Boost, MCash, ShopeePay, Touch 'N Go eWallet, Cards_KOR, Naver_Pay, Kakao_Pay and PAYCO, DANA, OVO, ShopeePay Indonesia, Akulaku, BNI VA, BRI VA, CIMB VA, Mandiri VA, Maybank VA, Permata VA, au, SoftBank, NTT Docomo, LINE Pay, Merpay, Paypay, Rakuten Pay, Paidy , BC_Card, Kookmin_Bank_Card, Hana_Bank_Card, Samsung_Card, Shinhan_Bank_Card, Hyundai_Card, Lotte_Card or Nonghyup_Bank_Card on PC WEB, Mobile WAP and wallet APP. 3.5 K PLUS on Mobile WAP and wallet APP. 3.6 SCB Easy Net on wallet APP. 4. Field Type: String(300) 4.1 When authentication.type=threeDSIntegrator or threeDSPage, the maximum is 75. 4.2 When Payment Brand is Alipay or AlipayHK, the maximum is 200. 5. The format of the webhook must contain http:// or htps://

senderInfo

object

In funding transfer transaction, this object is used to send sender information.

storeInfo

object

Supplemental store information need to be provided by merchant - Usage definition: 1. To indicate MCC for this merchant when the store is assigned multiple MCCs in EVO Cloud

subMerchantInfo

object

Information of merchant to initiate the transaction. - Usage instruction 1. Used in the request of Payment.

tradeInfo

object

Detailed information about the transaction - Usage Instruction 1. when paymentBrand=Alipay or AlipayHK, this field must be present 2. Specify this parameter if you can obtain the information from the user. This helps EVO Cloud laundering and fraud detection, and increases payment success rates.

transAmount

object

Required

This is used to define the amount for the transaction - Usage Instruction 1. Used in POST Payment request, to send the payment transaction amount 2. Used in POST Capture request, to send the capture amount 3. Used in POST Refund request, to send the refund transaction amount 4. Used within object payment, capture or refund in response or notification from EVO Cloud, to specify the corresponding amount of the objects. 5. Used in POST PaymentMethod, to indicate Currency for this transaction when the store is assigned multiple Currencies in EVO Cloud. If the store is not assigned multiple Currencies, this object will be ignored.

transInitiator

object

Required

Information of terminal to initiate the transaction - Usage instruction 1. Used in the request of PaymentMethod, Payment.

userInfo

object

Detailed information about the buyer - Usage Instruction 1. Used in POST Payment request and POST PaymentMethod request, to send the buyer's information. 2. Specify this parameter if you can obtain the information from the user. This helps EVO Cloud laundering and fraud detection, and increases payment success rates.

validTime

string<= 5 characters

The effective time (Minutes) of the Order, which can be performed Payment before the time. The valid time will be sent to E-Wallet to indicate the valid time of the order pre-generated. -Value defined: 1. E-Wallets defined different valid time value including minimum, maximum and default (not present) 2. It is suggested for merchant to define the value between 5 minutes to 120 minutes (2hours) 3. If not present, the valid time will follow the defult value of E-Wallets - Usage Instruction 1. Only used when paymentMethod.type=e-wallet or onlineBanking(UnionPay). 2. If merchant has special requirement for this value definition, please contact EVO Cloud product team for detail information and suggestion. 3. Field Type: String(5)

webhook

string<= 300 characters

This filed is used for merchant to provide asynchronous notification address - Usage Instruction 1. Merchant may provide this information in the request message, once it is processed successfully, EVO Cloud will send back notification to this address 2. The format of the webhook must contain http:// or htps:// 3. Field Type: String(300)

Responses

200

POST

/g2/v1/payment/mer/{sid}/payment

Try it

Server

https://online-uat.everonet.com

Path Parameters

sid

Header Parameters

Authorization

Content-type

DateTime

KeyID

MsgID

SignType

Idempotency-Key

Query Parameters

merchantTransID

Request Body Parameters

Request Samples

cURL

curl -i -X POST \
'https://online-uat.everonet.com/g2/v1/payment/mer/{sid}/payment?merchantTransID=string' \
 -H 'Authorization: string' \
 -H 'Content-type: application/json' \
 -H 'DateTime: string' \
 -H 'KeyID: string' \
 -H 'MsgID: string' \
 -H 'SignType: string' \
 -H 'Idempotency-Key: string' \
 -d '{
  "allowAuthentication": false,
  "captureAfterHours": "0",
  "merchantTransInfo": {
    "merchantTransID": "T504111744336445912",
    "merchantTransTime": "2025-04-11T09:54:05+08:00"
  },
  "metadata": "This is a metadata",
  "transAmount": {
    "currency": "HKD",
    "value": "1.00"
  },
  "transInitiator": {
    "platform": "WEB"
  }
}'

JavaScript

const query = new URLSearchParams({
  "merchantTransID": "string"
}).toString()

const sid = 'YOUR_sid_PARAMETER';
fetch(
`https://online-uat.everonet.com/g2/v1/payment/mer/${sid}/payment?${query}`,
{
  method: 'post',
  headers: {
  'Authorization': 'string',
  'Content-type': 'application/json',
  'DateTime': 'string',
  'KeyID': 'string',
  'MsgID': 'string',
  'SignType': 'string',
  'Idempotency-Key': 'string'
},
  body: '{
  "allowAuthentication": false,
  "captureAfterHours": "0",
  "merchantTransInfo": {
    "merchantTransID": "T504111744336445912",
    "merchantTransTime": "2025-04-11T09:54:05+08:00"
  },
  "metadata": "This is a metadata",
  "transAmount": {
    "currency": "HKD",
    "value": "1.00"
  },
  "transInitiator": {
    "platform": "WEB"
  }
}'
})
  .then(response => response.json())
  .then(data => console.log(data));

Response Samples

200

application/json

Successful

Failed