Treasury
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.
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
batchId*string
Payout batch ID.
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.cancelPayoutBatch({ path: { batchId: 'batch_abc123', },});console.log(data);{ "batch": { "id": "string", "campaignId": "string", "status": "awaiting_payment", "method": "card", "amountCents": 0, "feeCents": 0, "totalCents": 0, "items": [ { "id": "string", "participantId": "string", "creator": { "displayName": "string" }, "amountCents": 0, "feeCents": 0, "totalCents": 0, "status": "pending", "failureReason": "string", "transferId": "string" } ], "paidAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }}Was this page helpful?