Returns the balance of one of your accounts, together with the card deposits that are on their way into it. Works for any account you own, including a client-level account that GET /v1/accounts does not list.

  • available is what can be spent or paid out now. A payout is reserved against this figure only.
  • pending is the ledger pending balance, as GET /v1/accounts reports it: funds held for operations still in flight, such as a payout that is not final yet.
  • settling sums the deposits the payer has already paid that wait for the card acquirer to settle them (deposit status processing). They are not part of available until the deposit reads completed. How long that takes depends on the card acquirer: for a card deposit created with the card details (cardDetailsRequired: true) it is by default four business days (Monday to Friday, UTC). nextSettlementAt is the earliest time one of them is expected to settle, or null when none is.
  • awaitingPayment sums the deposits the payer has not finished paying yet (deposit status created or awaiting_payment, for example 3-D Secure still open).

Deposits in manual_review are counted in neither. Amounts are what each deposit will credit, net of fees, in the account currency.

Parameters

NameInTypeRequiredDescription
accountId path string yes

Unique identifier of the account.

Responses

StatusBodyDescription
200 AccountBalanceSummary

Balance retrieved.

404 Error

Account not found.

Specification

This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.