POST/v1/billing/payments/{id}/cancel

Cancel a pending top-up request

Only pending requests can be cancelled; a registered payment stays.

Scope billing.manage

Path parameters

idstringrequired

Returns

17 fields of the 200 answer

idstringrequired

kindenumrequired

TOP_UPINVOICE_PAYMENT

providerstringrequired

statusenumrequired

PENDINGCOMPLETEDCANCELLED

amountCentsintegerrequired

currencystringrequired

methodenum or nullrequired

BANK_TRANSFEROTHER

referencestringrequired

externalReferencestring or nullrequired

paidAtdate-time or nullrequired

invoiceIdstring or nullrequired

ledgerEntryIdstring or nullrequired

notesstring or nullrequired

requestedByTypeenumrequired

USERAPI_KEYADMINSYSTEM

completedAtdate-time or nullrequired

cancelledAtdate-time or nullrequired

createdAtdate-timerequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.billing.cancelPayment('pay_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

{ "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "kind": "TOP_UP", "provider": "Example", "status": "COMPLETED", "amountCents": 1250, "currency": "EUR", "method": "BANK_TRANSFER", "reference": "PB-2026-0001", "externalReference": "Example", "paidAt": "2026-10-16T09:14:02.000Z", "invoiceId": "inv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "ledgerEntryId": "led_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "notes": "Example", "requestedByType": "USER", "completedAt": "2026-10-16T09:14:02.000Z", "cancelledAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z" }