/v1/balances

Get available and hold balances

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeLocationRequiredDescription
AuthorizationstringHeaderYesYour API key.

Response

200 OK

FieldTypeDescription
statusstringRequest status.
resultobjectWrapper for the balances.
result.available_balanceobjectAvailable balance: amount and currency.
result.hold_balanceobjectHold balance: amount and currency.
result.timestampstringTimestamp of the balance data.
Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json