Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-211097127.9 KB

Create Charge

Initiate an account-to-account charge. X-GatePay-On-Behalf-Of specifies the initiating account ID for this transaction, and accountId specifies the payer account ID (the debited account). In the current version, this is a synchronous API and returns the final execution result directly.

post/transfer/open/institution/v1/pay/charge

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-Timestampstring required
Example:1672905655498

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 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.

X-GatePay-Signaturestring required

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

X-GatePay-On-Behalf-Ofstring required

Required delegated subject header. Provide the initiating account ID for this transaction. It can be an institution account ID or a sub-account ID.

Request body

merchantBatchNostring required

Unique batch ID from the merchant.

accountIdstring required

Payer account ID (the debited account).

currencystring required

Transfer currency.

amountstring required

Transfer amount.

Response

Success

statusstring
codestring
errorMessagestring

Example response

{
  "status": "SUCCESS",
  "code": "000000"
}