Get pending earnings breakdown

GET

/payouts/earnings/pending-breakdown

Per-donation attribution of the creator's not-yet-available money, lazy-loaded by the Earnings tab's Pending-tile dialog (#1131). The target is always the authenticated principal. Each donation is classified into one of three states: destination_charge_pending (Stripe holds it for this creator, card settlement pending), platform_held_unsettled (platform balance, awaiting settlement), or platform_held_settled (platform balance, eligible for release now). Rows already transferred to the creator's Stripe balance, settled destination charges, and rows under review are excluded. Rate limited to 100 requests per minute per account.

Authorizations

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type

HTTP (bearer)

Responses

Pending breakdown (all amounts in cents)

Content-Type

application/json

{

"pending_breakdown": {

"has_payout_account": true,

"total_cents": 0,

"destination_charge_cents": 0,

"platform_held_unsettled_cents": 0,

"platform_held_settled_cents": 0,

"donations": [

{

"donation_id": "string",

"amount_cents": 0,

"fundraiser_title": "string",

"fundraiser_slug": "string",

"state": "string",

"available_on": "string",

"donated_at": "string"

}

]

}

}

GET

/payouts/earnings/pending-breakdown

Playground

Server

Authorization

BearerAuth

Samples

Powered by VitePress OpenAPI