Sign in

v1

latestOpenAPI 3.0.02026-07-24130633.0 KB
payment

capture

post/payment/{merchantTransID_of_payment}/capture

Path parameters

merchantTransID_of_paymentstring required

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

webhookstring

This filed is used for merchant to provide asynchronous notification endpoint

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

This field is used for merchant to state the reason to initiate the transaction

  • Usage Instruction
  1. It is suggested to send this field in the process of DELETE PaymentMethod, POST Capture, POST Cancel, and POST Refund
  2. For DELETE PaymentMethod request, if merchant needs to remove WeChat Pay token, this field must be presented.
  3. Field Type: String(64)
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)

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)