Shop balances
GET /v1/balances
Return the current balance position of the shop identified by X-API-Key in
every supported currency. Do not send a shop or merchant identifier: the API
key is the only source of scope.
Endpoint
GET /v1/balances
X-API-Key: 01234567-89ab-4cde-8f01-23456789abcdcurl https://api.casheradminmatch.com/v1/balances \
-H "X-API-Key: 01234567-89ab-4cde-8f01-23456789abcd"Response
{
"balances": [
{
"currency": "RUB",
"balance": "-120.00",
"current_minus": "20.00",
"reserved": "100.00"
},
{
"currency": "USDT",
"balance": "45.50",
"current_minus": "0.00",
"reserved": "0.00"
}
]
}All monetary fields are exact decimal strings in the named currency. A row is returned for every supported currency, including zero positions.
| Field | Meaning |
|---|---|
currency | Currency of every amount in the row. |
balance | Current credit-natural shop balance. Positive means CasherMatch owes the shop; negative means the shop position is overdrawn. An in-flight payout reserve has already reduced this value. |
current_minus | Current shop debt to CasherMatch, excluding in-flight payout reserves. Always non-negative. |
reserved | Amount reserved for in-flight payouts. Always non-negative. |
The debt calculation is:
current_minus = max(-(balance + reserved), 0)The reserve is added back only for calculating current_minus, because payout
reservation debits balance and credits reserved at the same time. This
prevents an in-flight payout from being reported as an already realized shop
debt. The response itself remains point-in-time and may change immediately
after a payment, payout reserve, completion, failure or settlement.
Errors
401—X-API-Keyis missing, invalid or revoked.503— the accounting service is temporarily unavailable; retry with exponential backoff.500— the accounting position is internally inconsistent. No partial or fabricated zero response is returned.