GAgate
withdraw

Place withdrawal order

Changed on

Create a batch withdrawal order. The merchant submits one batch ID with multiple withdrawal sub-orders.

post/v1/pay/withdraw

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/withdraw
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

The clientId assigned when the merchant registers an application in the Gate merchant console.

X-GatePay-Signaturestring required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Request body

batch_idstring required

A unique ID generated by the merchant, composed of uppercase and lowercase letters, numbers, and underscores, max length 32 characters.

channel_idstring

Client name.

batchRemarkstring

Remark. Maximum length 200 characters.

Response

Withdrawal batch created

statusstring required

API response result, SUCCESS or FAIL.

codestring required

Response error code.

errorMessagestring

Error description.

Changes