Zernio
APIFor you
Zernio
APIFor you
API Reference

Creator Campaigns

List campaign ledgerGETList campaign participantsGETList campaign payablesGETList payout batchesGETList campaign submissionsGETList creator campaignsGETCreate campaign adjustmentPOSTCreate campaign invite linkPOSTInvite campaign participantPOSTPay creators with one card paymentPOSTCreate creator campaignPOSTGet campaign participantGETGet campaign reportGETGet campaign submissionGETGet creator campaignGETUpdate creator campaignPATCHActivate creator campaignPOSTApprove campaign submissionPOSTClose creator campaignPOSTPause creator campaignPOSTRaise creator campaign budgetPOSTReinstate campaign participantPOSTReject campaign submissionPOSTRemove campaign participantPOSTReopen campaign submissionPOSTSettle campaign participantPOSTSuspend campaign participantPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Creator Campaigns

List campaign ledger

Lists ledger entries, newest first. Without participantId it lists every entry of the campaign: earnings drawn from the budget (accruals, per-post payments, pool shares, adjustments), the approvals, hold releases and settlements that move money between its participants' buckets, and their reversals. Pass participantId to narrow the list to one participant's entries.

GET
/v1/creator-campaigns/{campaignId}/ledger

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

campaignId*string

Campaign ID.

Query Parameters

participantId?string

List only this participant's entries.

kind?string

Value in

  • "accrual"
  • "approval"
  • "hold_release"
  • "adjustment"
  • "settling"
  • "settlement"
  • "reversal"
  • "topup"
  • "transfer"
  • "fee"
limit?integer
Range1 <= value <= 200
Default50
skip?integer
Range0 <= value
Default0

Response Body

application/json

application/json

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.creatorcampaigns.listCampaignLedger({  path: {    campaignId: 'campaign_abc123',  },});console.log(data);
{  "entries": [    {      "id": "string",      "kind": "accrual",      "amountCents": 0,      "debit": {        "scopeType": "string",        "scopeId": "string",        "bucket": "string"      },      "credit": {        "scopeType": "string",        "scopeId": "string",        "bucket": "string"      },      "holdUntil": "2019-08-24T14:15:22Z",      "releasedByEntryId": "string",      "reversesEntryId": "string",      "referenceType": "string",      "referenceId": "string",      "cause": "string",      "externalReference": "string",      "actor": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "total": 0,    "limit": 0,    "skip": 0  }}
Was this page helpful?

Check a verification code

Verify the code the user typed. Wrong, expired, and exhausted codes answer 200 with `valid: false` and the settled `status`. Only an unknown id is a 404. A correct code consumes the verification (single-use, `status: approved`) and fires the `verification.approved` webhook; the 5th wrong attempt settles it as `max_attempts_reached` and fires `verification.failed`.

List campaign participants

Lists the campaign's participants with their balances, flags and submission counts.