Skip to main content
GET
Check account balance

Overview

This page documents the GET /v1/pay/balance/query query balance endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant client ID

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

Signature

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8"

X-GatePay-Timestamp
string
required

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

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Nonce

Example:

"9578"

Response

200 - application/json

Success

status
enum<string>

SUCCESS or FAIL

Available options:
SUCCESS,
FAIL
code
string

Error code

errorMessage
string

Error message

data
object