embedders

Embedder Me Balance

Return the calling embedder's live custody balance.

Powers the FE PR #275 Claim-portal balance card.

Zero-state graceful: if no EmbedderBalance row exists yet (no revenue has landed for this embedder), surface a fully-zero shape instead of 404. The FE renders "$0.00 claimable" + "wallet provisioning" copy from the same shape.

claimable = accrued - withdrawn. Computed at read-time so a pending withdrawal in 'pending'/'processing' status (which hasn't yet bumped withdrawn_usdc_micros) is reflected as still-claimable. The Claim button on the FE separately disables itself if there's an in-flight withdrawal (that check uses /withdrawals, not /balance).

get/v1/embedders/me/balance

Request

  • Base URL: https://api.storyflo.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.storyflo.com/v1/embedders/me/balance
  • Auth: none declared

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.