Skip to Content
Version 1.1 · A Coming soon badge is a backward-compatible change still rolling out.
Balance

Balance

POST /balance

Returns the balances on your account. Omit currency to receive every currency.

Response keys on this endpoint are snake_case: available_balance and ledger_balance. Request fields stay camelCase.

Request

FieldRequiredNotes
currencynoFor example JPY. Omit to list every balance.
timestamp, nonceyesSee signing

Samples

balance.sh
API_KEY="YOUR_API_KEY" SECRET_KEY="YOUR_SECRET_KEY" BASE_URL="https://api-sandbox.inspay.dev/merchant" CANONICAL='{"currency":"JPY","nonce":"e7f8a9b0","timestamp":"1791729147"}' SIG=$(printf '%s' "$CANONICAL" | openssl dgst -sha256 -hmac "$SECRET_KEY" -hex | awk '{print $NF}') curl -sS -X POST "$BASE_URL/balance" \ -H "Content-Type: application/json" \ -H "x-api-key: $API_KEY" \ -H "x-signature: $SIG" \ --data-binary "$CANONICAL"

Response 200

balance-response.json
[ { "currency": "JPY", "available_balance": 4955, "ledger_balance": 4955 } ]

A withdrawal hold reduces the available balance by amount + fee when the withdrawal is created.

Last updated on