get
https://cs-api.sandbox.paybis.com/v1/balances
Get available and hold balances
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieves the current available balance and hold balance for the business account associated with the API key.
Overview
- Use this endpoint to check whether sufficient funds are available before submitting a payout request.
Request
GET /v1/balances
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
Authorization | string | Header | Yes | Your API key. |
Response
200 OK
| Field | Type | Description |
|---|---|---|
status | string | Request status. |
result | object | Wrapper for the balances. |
result.available_balance | object | Available balance: amount and currency. |
result.hold_balance | object | Hold balance: amount and currency. |
result.timestamp | string | Timestamp of the balance data. |