Retrieve balances

GET

/gateway/balances

• Shared development environment (test money only)

Required scope: payments:read.

Authorizations

• apiKeyAuth

Responses

200

Success

object

asset_balances

Array<object>

object

available

required

string

/^-?[0-9]+(\.[0-9]+)?$/

cleared

required

string

/^-?[0-9]+(\.[0-9]+)?$/

currency

required

string

reserved

required

string

/^-?[0-9]+(\.[0-9]+)?$/

currencies

object

key

additional properties

string

/^-?[0-9]+(\.[0-9]+)?$/

environment

required

string

ghs_available

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

ghs_available_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

ghs_cleared

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

ghs_cleared_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

ghs_reserved

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

ghs_reserved_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

merchant_id

required

string format: uuid

settlement_preference

required

string

unallocated_buckets

object

dust

required

Array<object>

object

asset

required

string

count

required

integer

total_amount_smallest

required

string

/^[0-9]+$/

excess

required

Array<object>

object

asset

required

string

count

required

integer

total_amount_smallest

required

string

/^[0-9]+$/

usdt_available

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

usdt_available_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

usdt_cleared

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

usdt_cleared_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

usdt_reserved

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

usdt_reserved_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

usdt_treasury

Legacy display value. Use its exact decimal-string counterpart for financial decisions.

number

usdt_treasury_exact

required

string

/^-?[0-9]+(\.[0-9]+)?$/

400

Validation error

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

401

Invalid key

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

403

Scope, merchant or environment denied

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

404

Not found

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

409

Intent conflict

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

429

Rate limited

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

500

Internal error

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time

503

Service unavailable

R15 canonical error envelope. Every 4xx/5xx JSON body carries these five keys, plus x-request-id header; 4xx machine fields (e.g. available_balance) merge in alongside and never shadow them.

object

error

required

Machine code (SCREAMING_SNAKE)

string

Example

VALIDATION_ERROR

message

required

Human-readable detail

string

Example

amount_ghs must be greater than zero

request_id

required

Mirrors the x-request-id response header

string format: uuid

retriable

required

True for 429/502/503/504 only; 400/401/403/404/409 are final

boolean

timestamp

required

string format: date-time