Sign in

v1

latestOpenAPI 3.0.02026-07-24130633.0 KB
payment

payment

post/payment

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

SignTypestring required

Fixed value: Key-based.

Idempotency-Keystring

Request idempotent identity, no more than 64 characters.

Request body

allowAuthenticationboolean

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

  • Usage instruction:
  1. In Evonet, 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, Evonet will conduct additional authentication for this transaction or tokenize.
  3. If not present, means default value=false, Evonet 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
authenticationOnlyboolean

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, Evonet will conduct authentication only without authorization followed.
  2. if not present, means default value = false, Evonet 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
validTimestring

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 Evonet product team for detail information and suggestion.
  3. Field Type: String(5)
captureAfterHours'0' | '1-168' | 'not present'

The number of hours for Evonet 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 Evonet 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)
returnURLstring

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+ on PC WEB, 3.2 Alipay, Alipay+, Alipay HK, WeChat Pay and on Mobile WAP, 3.3 WeChat Pay in Official Account, 3.4 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, on PC WEB, Mobile WAP and wallet APP. 3.5 K PLUS on Mobile WAP and 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://
webhookstring

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

metadatastring

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

allowAvsCheckstring

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

Response

extendAuthorizationDateIndicator'Y' | 'N'

Extend Authorization Date Indicator

  • Usage Instruction
  1. This field is suitable for the paymentBrand=Visa
metadatastring

This field is used for merchant to state reference information

  • Usage Instruction
  1. If merchant sends this field in the request message, Evonet will echo it back in the response
  2. Field Type: String(512)