Skip to main content
Use this endpoint before creating withdrawals or conversions so you can validate spendable funds and reduce avoidable failures.

Prerequisites

  • Use a valid API key in the Authorization header. See Authentication Overview.
  • Ensure you call the same environment you are operating in (sk_sandbox_... or sk_live_...).

Request

Method & Path

Required Headers

Request Example


Response

200 - Success

Response Fields

string
Organization ID the balances belong to.
array
One object per currency with spendable and non-spendable amounts.
string
Currency code for this bucket (ISO 4217 or configured crypto code).
string
Amount currently available for new operations in this currency.
string
Amount in transit that is not yet available.
string
Sum of available_balance and pending_balance across currencies, converted to USD. A display total; no operation accepts it.
array
When each pending amount becomes available, grouped by date and currency. Schedule transfers and withdrawals against it rather than against the charge succeeding.
string
ISO 8601 date the amount becomes available.
string
Currency code for pending_settlements_by_day[].total.
string
Amount arriving on that date in that currency, as a decimal string.

Error Responses

Cause: API key is missing, invalid, or revoked.Resolution: Send a valid key in the Authorization header.
Cause: Organization could not be resolved from your key context.Resolution: Verify you are using the correct key and environment.