Zernio
APIFor you
Zernio
APIFor you
API Reference

Creator Portal

Open the creator's Stripe dashboardPOSTDownload a payout statementGETList a creator's earnings historyGETRead a creator invite or participant pageGETJoin a campaignPOSTEmail a creator their campaign linksPOSTStart connecting a creator accountPOSTStart payout onboardingPOSTSubmit a postPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Creator Portal

List a creator's earnings history

The participant's ledger entries, newest first, with the bucket each one moved money from and to (accruing, owed, payable, settling, settled; null for the other side), plus the payout setup. Never cached.


GET
/public/creator-campaigns/{token}/payouts

Path Parameters

token*string

A participant token or an open invite token. A malformed token answers 404 like an unknown one.

Match^[A-Za-z0-9_-]{16,128}$

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
skip?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.creatorportal.getCreatorPayouts();console.log(data);
{  "entries": [    {      "id": "string",      "kind": "accrual",      "amountCents": 0,      "fromBucket": "string",      "toBucket": "string",      "holdUntil": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "payouts": {    "mode": "none",    "status": "not_started",    "country": "string",    "transfers": [      {        "id": "string",        "amountCents": 0,        "createdAt": "2019-08-24T14:15:22Z"      }    ]  }}
Was this page helpful?

Download a payout statement

A PDF statement of one paid payout to this creator: who paid, the campaign, the date, the amount and the Stripe transfer id. It is a statement of a payment, not a tax invoice. Only for a paid payout of this participant; anything else answers 404. About 60 downloads per participant every 10 minutes.

Read a creator invite or participant page

What a creator sees behind a campaign link, with no API key. `token` is either an open invite token (from `POST /v1/creator-campaigns/{campaignId}/invite-link`), which answers `kind: invite` with the campaign only, or a participant token (from an invite or a join), which answers `kind: participant` with the creator's connected accounts, latest 100 submissions, earnings and payout setup. Reading a participant page also re-checks the creator's connected accounts. Never cached.