GAgate

Check account balance

Retrieve the payment account balance for the merchant.

get/v1/pay/balance/query

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/balance/query
  • 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

Merchant client ID

X-GatePay-Signaturestring required
Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8

Signature

X-GatePay-Timestampstring required
Example:1672905655498

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

X-GatePay-Noncestring required
Example:9578

Nonce

Response

Success

status'SUCCESS' | 'FAIL'

SUCCESS or FAIL

codestring

Error code

errorMessagestring

Error message

Changes

No recorded changes to this operation across all 3 revisions of this API.