Zernio
APIFor you
Zernio
APIFor you
API Reference

Treasury

List payeesGETList top-upsGETList transfersGETCreate a payee onboarding linkPOSTCreate a top-upPOSTCreate a transferPOSTGet balanceGETGet a payout batchGETGet a top-up receiptGETGet a transferGETCancel an unpaid payout batchPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Treasury

Get a transfer

GET
/v1/transfers/{transferId}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

transferId*string

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.treasury.getTransfer({  path: {    transferId: 'transfer_abc123',  },});console.log(data);
{  "id": "string",  "payeeId": "stringstringstringstring",  "payeeName": "string",  "destinationType": "creator",  "amountCents": 0,  "feeCents": 0,  "totalCents": 0,  "currency": "string",  "reference": {    "type": "string",    "id": "string",    "name": "string"  },  "status": "pending",  "failureReason": "string",  "createdAt": "2019-08-24T14:15:22Z"}
Was this page helpful?

Get a top-up receipt

The receipt for a paid top-up or creator payout payment (`purpose: payout_batch`). `format: pdf` is the Stripe invoice PDF; `format: page` is Stripe's receipt page, for payments that have no invoice. The link is short-lived, so fetch it when you need it. A profile-scoped key answers 403.

Cancel an unpaid payout batch

Ends the Stripe Checkout of a batch that is still `awaiting_payment` and makes every amount payable again right away, instead of after Stripe's 24-hour expiry. A batch that was already paid is returned unchanged. Needs an owner, admin or billing admin, signed in or through a full-access key they created.