Fetch recipient balance

Returns the real-time balance of a recipient's ledger: the money you've routed to them through split payments that hasn't been paid out yet. The response has the ledger's identifier, its balance, and its currency.

How the balance moves

  • The recipient's share of a split payment (a payment link with payouts_share) is credited to their ledger on the payment's settlement date, together with your own share of that payment (in the first hourly run that day). It is credited at capture only if your account settles same-day (settlement period 0).
  • The accrued balance is paid out to the recipient's bank account on a schedule: monthly by default, configurable for your account. The balance goes down when that payout is issued.
  • A recipient with no bank account on file is not paid out; their balance keeps accruing.
📘

Empty response before the first split

The ledger is created on the first credit. A recipient that hasn't received any split yet returns an empty object {}, not a zero balance. This is expected, not an error.

The payment webhook payload doesn't include payouts_share. To see the split configured on a payment, read the payment link with Fetch payment link info; to see what has accrued, use this endpoint.

Path Params
string
required
Defaults to REP-3C4D5E6F7A

Recipient Identifier

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

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