Skip to main content

Void a Payment [v3]

Void a Payment [v3]

POST 
/api/v3/void

Void (cancel) a pre-authorized payment transaction, releasing the held funds back to the customer. Only applicable when the sub-merchant account has capture_mode=manual configured. Nimbbl exposes a single interface across every supported payment partner — you don't need partner-specific logic.

A void permanently cancels the authorization — the funds are released and the transaction cannot be captured afterward. Use this when you want to cancel the payment without charging the customer. Void is a single call for every supported partner; Nimbbl handles partner-specific mechanics on the backend.

The response void_status is succeeded, pending, or failed. A pending status is a normal asynchronous outcome (not an error) — confirm via the void_success webhook or Transaction Enquiry. A 4XX is returned when the transaction is not found or is not in the authorized state (for example, it was already captured or voided, or the hold has expired). A successful void moves the payment to reversed and the order to lapsed.

Quick Reference
  • Required: transaction_id of the authorized parent transaction
  • Auth: Merchant token (server-to-server only)
  • Prerequisite: Transaction must be in authorized status with capture_mode=manual
  • Data Security: Encryption supported

Request​

Responses​

Void request accepted. Check void_status — it can be succeeded, pending, or failed.