API Explorer
go to Evonet

payment

post
https://sandbox.evonetonline.com/payment
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 32
deprecated

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

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
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.
localAmount
object
deprecated

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.
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
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
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
string
length ≤ 5

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(WeChat Pay and Alipay+) 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)
string
enum
length ≤ 3

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)
Allowed:
string
length ≤ 300

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://
string
enum
length ≤ 1

Extend Authorization Date Indicator

  • Usage Instruction
  1. This field is suitable for the paymentBrand=Visa
Allowed:
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
  1. EVO Cloud supports securePlue and threeDS authentication types
transInitiator
object
required

Information of terminal to initiate the transaction

  • Usage instruction
  1. Used in the request of PaymentMethod, 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.
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.
subMerchantInfo
object

Information of merchant to initiate the transaction.

  • Usage instruction
  1. Used in the request of Payment.
string
length ≤ 300

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)
string
length ≤ 512

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)
Headers
string
required

Sign key assigned by EVONET

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.

string
required

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

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

string
required

Fixed value: Key-based

string
length ≤ 64

Request idempotent identity, no more than 64 characters.

Response

Updated about 1 year ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?