ZEzernio
Treasury

Cancel a top-up

Changed on

Ends the payment of a pending top-up (3D Secure left unfinished), so it stops counting toward pendingTopupCents, and returns it as expired.

  • When Stripe reports it already paid, the top-up is credited and comes back succeeded.
  • A top-up that is no longer pending comes back unchanged.
  • A creator payout payment (purpose: payout_batch) answers 409; cancel it from its campaign.

Needs an owner, admin or billing admin, signed in or through a full-access key they created.

post/v1/balance/top-ups/{topupId}/cancel

Request

  • Base URL
    https://zernio.com/api
  • URL
    https://zernio.com/api/v1/balance/top-ups/{topupId}/cancel
  • Auth
    HTTP bearer

Path parameters

topupIdstring required

Response

The top-up after cancelling

idstring
method'card' | 'bank_transfer'
purpose'balance' | 'payout_batch'

balance funds your balance; payout_batch is the card payment of one payout batch, which pays its creators directly.

feeCoveredByZernioboolean

True for a payout_batch payment: Zernio pays the Stripe processing fee out of its transfer fee, so you are credited the whole charge.

amountCentsinteger

Gross amount charged

stripeFeeCentsinteger nullable

Stripe processing fee you paid; null until Stripe reports it, 0 when Zernio covers it

netCentsinteger nullable

Amount credited to your balance: gross minus the Stripe fee, or the whole charge when Zernio covers the fee; null until Stripe reports it

status'pending' | 'succeeded' | 'failed' | 'expired'

pending until the card is charged (or 3D Secure is finished) and credited. expired means it ended unpaid: cancelled, or 3D Secure left unfinished for 30 minutes. Only pending counts toward pendingTopupCents.

createdAtstring date-time
succeededAtstring date-time nullable

Changes