Bloss Docs

Funds balance and recent activity

Developers
GET
/brands/{brandId}/funds

The brand's balance for paying creators on the platform-managed payout provider, and its latest 25 ledger entries, as on the funds card in Settings › Integrations. Read from Bloss's own ledger; nothing here opens a payment. available: false when this deployment has no platform-managed provider.

Authorization

bearerAuth funds:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: funds:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Response Body

Success.

application/json
  1. response
available*boolean
mode*|

"test" = sandbox money.

currency*string
balance*number

US dollars.

recentEntries*array<>
curl -X GET 'https://example.com/api/v1/brands/string/funds'
{  "available": true,  "mode": "test",  "currency": "USD",  "balance": 0,  "recentEntries": [    {      "id": "string",      "kind": "string",      "amount": 0,      "balanceAfter": 0,      "description": "string",      "createdAt": "string"    }  ]}

Was this page helpful?