Get Balance

Returns the balance available for dispersing withdrawals. Check it before creating withdrawals via `POST /process/` to avoid rejections for insufficient funds.

GET
/withdrawals/balance

Authorization

Authorization
Authorization<token>

Your public API key, with the word Token and a space in front of it. Example: Token 6534bc0a7e1f4d2b9c8e3a5f7b1d2c4e6f8a9b0c — that whole value is the header. Sending the key alone returns 401 'Authentication credentials were not provided'. In this playground you may paste just the key; the prefix is added for you.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/withdrawals/balance"
{
  "message": "Data retrieved successfully",
  "current_balance": "32894.55"
}
{
  "code": 0,
  "message": "string"
}
Was this page helpful?