2136e26ceb19

latestOpenAPI 3.0.02026-07-24130633.0 KB

paymentMethod

get/paymentMethod?merchantTransID={merchantTransInfo_merchantTransID}

Path parameters

merchantTransInfo_merchantTransIDstring required

Query parameters

merchantTransIDstring

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

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

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

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

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

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

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'
amountstring

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

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

Request body

object required

Response

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)