Zernio
APIFor you
Zernio
APIFor you
API Reference

Ledger

List ledger entriesGETGet ledger balancesGET
Dashboard
OverviewPlatformsAPI ReferenceResources
Ledger

List ledger entries

Lists ledger entries for your team, newest first. Filter by scope (matches either side of the entry), kind, or the reference that caused the entry. A profile-scoped key (or a member limited to some profiles) only sees entries of campaigns under its profiles and of their participants; operator and platform scopes stay hidden from it.

GET
/v1/ledger/entries

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

scopeType?string
scopeId?string
kind?string

Value in

  • "accrual"
  • "approval"
  • "hold_release"
  • "adjustment"
  • "settling"
  • "settlement"
  • "reversal"
  • "topup"
  • "transfer"
  • "fee"
referenceType?string
referenceId?string
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.ledger.listLedgerEntries();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",      "referenceType": "string",      "referenceId": "string",      "reversesEntryId": "string",      "cause": "string",      "actor": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "total": 0,    "limit": 0,    "skip": 0  }}
Was this page helpful?

Suspend campaign participant

Suspends an `active` participant: they can no longer submit posts. Any other status answers 409.

Get ledger balances

Returns the balance of each bucket (for example accruing, owed, payable) for one ledger scope. A scope owned by another team returns an empty balances object. A profile-scoped key (or a member limited to some profiles) only reads `campaign` and `participant` scopes of campaigns under its profiles; any other scope returns an empty balances object.