Fetch Recipient Balance

Fetches the real-time balance of a recipient's ledger. For a split payment, the recipient's payouts_share is credited to their ledger when the payment is captured — not later at settlement. The ledger is created on the first credit, so a recipient that has not yet received any split returns an empty object {} (rather than a zero balance); this is expected, not an error. The accrued ledger balance is paid out to the recipient's bank account on a schedule (by default monthly, configurable per merchant), and the balance is deducted when that payout is issued.

Note: the payment/charge webhook object does not include payouts_share; the split amount is available on the payment link object instead. Use this endpoint to check a recipient's accrued ledger balance.

Path Params
string
required
Defaults to REP-6BB7CA8DC7

Recipient Identifier

Headers
string
Responses

500

Unexpected error

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