Skip to main content

Capture a Payment [v3]

Capture a Payment [v3]

POST 
/api/v3/capture

Capture a pre-authorized payment transaction. 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.

After a successful authorization, the funds are held but not yet settled. Call this endpoint to complete the capture and trigger settlement. If you do not capture within the authorization window, the hold will expire automatically.

Capture is always for the full authorized amount — partial capture is not currently supported. Capture works the same way across every supported partner; Nimbbl handles partner-specific behaviour on the backend.

The response capture_status is succeeded, pending, or failed. A pending status is a normal asynchronous outcome (not an error) — confirm the result via the capture_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).

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​

Capture request accepted. Check capture_status — it can be succeeded, pending, or failed.