paymentMethod

post

https://sandbox.evonetonline.com/paymentMethod

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

transAmount

object

This is used to define the amount for the transaction

Usage Instruction

Used in POST Payment request, to send the payment transaction amount
Used in POST Capture request, to send the capture amount
Used in POST Refund request, to send the refund transaction amount
Used within object payment, capture or refund in the response or notification from Evonet, to specify the corresponding amount of the objects.
Used in POST PaymentMethod, to indicate currency for this transaction when the store is assigned multiple currencies in Evonet. If the store is not assigned multiple currencies, this object will be ignored.

allowAuthentication

boolean

This is to indicate if this Payment or Payment Method needs to conduct authentication

Usage instruction:

In Evonet, each merchant is configured with Non-Authentication, Optional-Authentication and Must-Authentication. When store is configured Optional-Authentication, this field is applied.
This filed is used in POST Payment request and Payment Method request, if true, Evonet will conduct additional authentication for this transaction or tokenize.
If not present, means default value=false, Evonet will not conduct authentication process for this transaction
Only used when paymentMethod.type=card
In Payment request, when paymentMethod.type=card and authenticationOnly=true this field is not applied.
Field Type: boolean

returnURL

string

length ≤ 300

Defaults to https://www.evonetglobal.com

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

Required in POST PaymentMethod or POST Payment request message when 3DS authentication is being performed.
Required in POST PaymentMethod request message when performing the tokenization with Alipay.
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, 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
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.
The format of the webhook must contain http:// or htps://

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

authentication

object

The information used for User authentication with Card

Usage Instruction

Evonet supports securePlus and threeDS authentication types

transInitiator

object

required

Information of terminal to initiate the transaction

Usage instruction

Used in the request of PaymentMethod, Payment.

userInfo

object

Detailed information about the buyer

Usage Instruction

Used in POST Payment request and POST PaymentMethod request, to send the buyer's information.
Specify this parameter if you can obtain the information from the user. This helps Evonet laundering and fraud detection, and increases payment success rates.

subMerchantInfo

object

required

webhook

string

length ≤ 300

Defaults to https://6ee8218a-52e4-4b16-8d67-594cdb34bb23.mock.pstmn.io

This filed is used for merchant to provide asynchronous notification endpoint

Usage Instruction

Merchant may provide this information in the request message, once it is processed successfully, Evonet will send notification to this endpoint
The format of the webhook must contain http:// or htps://
Field Type: String(300)

metadata

string

length ≤ 512

This field is used for merchant to state reference information

Usage Instruction

If merchant sends this field in the request message, Evonet will echo it back in the response
Field Type: String(512)

Headers

Authorization

string

required

Defaults to sk_sandbox_bf0cbe50878a45529b5d121ce6ba84f2

Sign key assigned by Evonet

DateTime

string

required

Defaults to 2026-04-17T18:02:01+08:00

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

required

Defaults to kid_bfdd40e3d619476ba0f5be9c0d33e75a

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

MsgID

string

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. Evonet will not validate this value and will echo it back in the response message.

SignType

string

required

Defaults to Key-based

Fixed value: Key-based

Idempotency-Key

string

Request idempotent identity, no more than 64 characters.

Response

200