paymentMethod

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to MTID00001231
Query Params
string

The merchantTransInfo.merchantTransID of the initial request.

  • Usage Instruction
  1. For POST Capture, Refund, Cancel 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. Field type: String(32)
string

The reference for the user. With this parameter specified, you can retrieve all of the Payment Method(s) saved for the specific user.

  • Usage Instruction
  1. For GET PaymentMethod, merchant can send this field in query URL
  2. Field type: String(64)
string

The token value for a specific saved Payment Method. With this parameter specified, you can retrieve the specific Payment Method saved with this token value.

  1. For PUT PaymentMethod or GET PaymentMethod, merchant can send this field in query URL to update or query token.
  2. Field type: String(64)
string

This is used to indicate the card BIN.

  • Usage Instruction:
  1. For GET PaymentMethod, merchant can send this field in query URL.
  2. The minimum length is 6
  3. Field Type: String(10)
string

This is used to indicate the payment brand

  • Value defined
    The accepted values of this field, please refer to the Appendix 8.8 payment brands
  • Usage Instruction:
  1. For GET PaymentMethod, merchant can send this field in query URL.
  2. Field Type: String(32)
string

This field is used to define the transaction currency.

  • Usage Instruction
  1. For GET PaymentMethod request, If merchant support multiple currency and the merchant wants to inquiry available payment method of one currency can send this filed.
boolean

Used to indicate Inquiry the payment method which support tokenization

  • Value definition
    true: Inquiry the payment method which support tokenization
    -Uasge Instruction
  1. Default value is 'false'
string
length ≤ 12

This field is used to define the transaction amount.

  • Usage Instruction
  1. Example:if currency=HKD, 12.34 means 12.34 HKD, 30 means 30.00HKD; if currency=JPY, 1234 means 1234 JPY
  2. This field must be used with field currency
Headers
string
required
Defaults to sk_sandbox_bf0cbe50878a45529b5d121ce6ba84f2

Sign key assigned by Evonet

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.

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

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.

string
required
Defaults to Key-based

Fixed value: Key-based

Response

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