Bloss Docs

Your payout setup in a brand

Developers
GET
/creator/brands/{brandId}/payout-account

Where this brand pays you: its payout provider, whether your account there is set up, and your PayPal details, as in Payout Settings on your dashboard. Emails and account ids are masked. Balances aren't included: reading one can open a wallet, and this API never changes anything.

Authorization

bearerAuth creator:earnings
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: creator:earnings

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
provider*string

The payout provider's name.

providerId*string
Value in"whop""sideshift"
managedForYou*boolean

True when the account is opened for you automatically: nothing to set up.

status*string

"not_set_up": no payout email saved yet; "awaiting_account": email saved, the brand still has to open the account; "active": you can be paid.

Value in"not_set_up""awaiting_account""active"
connected*boolean

You have an account on this provider, so payouts can reach you.

payoutEmail*|

The payout email you saved, masked.

payoutEmailLocked*boolean

The payout email can no longer be changed (the account exists).

accountId*|

Your account id on the provider, masked to its last 4 characters.

paypal*
curl -X GET 'https://example.com/api/v1/creator/brands/string/payout-account'
{  "provider": "string",  "providerId": "whop",  "managedForYou": true,  "status": "not_set_up",  "connected": true,  "payoutEmail": "string",  "payoutEmailLocked": true,  "accountId": "string",  "paypal": {    "email": "string",    "locked": true  }}

Was this page helpful?

You in one brand GET

What your dashboard in a brand shows about you: your status and join date, connected socials (with any account alerts), trial progress, the current cycle and your views, engagement and videos in it, and the brand's posting rules. Earnings are not included; read them with the earnings endpoints.

Your payouts in a brand GET

Your payouts in this brand, one per payout cycle (plus any bounty payouts), newest first: the period, base and bonus, what was paid early, what is transferred at cycle end, and whether and how it was paid. As on your Payouts page.