Capture and Cancel

Capture and cancel operations for pre-authorized purchases. Learn how to confirm or void an authorization using Bamboo’s API.

Capture and cancel operations allow merchants to manage the lifecycle of pre-authorized credit and debit card purchases. A capture finalizes an existing authorization, while a cancel voids it before settlement.


Capture a Purchase

A capture finalizes a pre-authorized purchase.
The operation may confirm the full authorized amount or a lower amount when partial capture is supported by the acquiring network.


📘

Authorization support varies by payment method and country.


Request URL

Production
https://api.bamboopayment.com/v3/api/purchase/{{TransactionId}}/capture

Staging
https://api.stage.bamboopayment.com/v3/api/purchase/{{TransactionId}}/capture


Request Parameters

The request body is optional.
If no body is sent, the purchase is captured for the full authorized amount.
If an amount is provided, it must be equal to or lower than the originally authorized amount.

FieldTypeMandatory?Description
AmountnumericNoAmount to capture. Must be ≤ the authorized amount.

Request Example – Partial Capture

{
  "Amount": 50
}

Response

The operation returns the standard Purchase Response object.
Refer to the Create a Purchase guide for detailed response fields.




Cancel a Purchase

A cancel (void) invalidates a pre-authorized purchase before it is captured or settled.
This operation is only available when the purchase is in PreAuthorized status.
To reverse a captured purchase, use the refund operation.


Request URL

Production
https://api.bamboopayment.com/v3/api/purchase/{{TransactionId}}/cancel

Staging
https://api.stage.bamboopayment.com/v3/api/purchase/{{TransactionId}}/cancel


Request Parameters

This operation does not accept request parameters.
The purchase is always canceled for the full authorized amount, and partial cancellation is not supported.


Response

The operation returns the standard Purchase Response object.
Refer to the Create a Purchase guide for detailed response fields.




Test the API

Use the API Reference to test the capture and cancel operations: