Get the payee's wallet balance

Server URLloading...

GET

/api/v1/payees/{id}/balance

Send

Authorization

Path

The payee's wallet balance — the SAME numbers the hosted payouts portal shows — so a consuming platform's own wallet (e.g. 8x-core) stays in sync with the portal by construction rather than re-deriving from its own ledger. Like /readiness, this is a pull backstop: always correct even if a balance webhook was missed.

The cent amounts describe where the payee's money is in the payout lifecycle:

• withdrawableCents — still-owed disbursements, not yet released into a payout. This is what the payee could withdraw right now.
• onTheWayCents — genuinely in transit (submitted to a rail, awaiting settlement) — not money that still needs the payee to act.
• actionNeededCents — money the creator must still claim/withdraw before it can move (e.g. a Grade payout that's been triggered but is unclaimed, or a SideShift leg-1 awaiting the payee) — NOT yet on the way.
• landedCents — lifetime settled (paid). A cumulative total, not a current balance.
• heldBelowMinimumCents — money held only because it's under the rail's economical floor (a below_min_payout hold that self-releases once the balance clears the floor). 0 when nothing is floor-held.
• minPayoutCents — the floor that held money must clear to release: the floor of the rail it's held on, or (when nothing is held) the payee's currently-resolved active rail. 0 if the rail can't be resolved.
• provider — the payee's single resolved payout rail (null if none). Lets a consumer tell whether actionNeededCents is SideShift leg-1 money already staged in the wallet (withdrawable now via leg 2) or a Grade claim / Stripe auto-send.

currency is the ISO 4217 code for these amounts.

Required scope: payees:read.

Path Parameters

Response Body

// The SDK has no helper for this endpoint yet. Use the cURL tab, or// call it with any HTTP client: the SDK's request signing scheme is// documented under Authorization on this page.

{  "withdrawableCents": 0,  "onTheWayCents": 0,  "actionNeededCents": 0,  "landedCents": 0,  "heldBelowMinimumCents": 0,  "minPayoutCents": 0,  "currency": "string",  "provider": "string"}