Capture authorization

The capture_authorization operation finalizes a previously created hold by converting reserved credits into consumed credits.

API Behavior

Completes an earlier authorize operation.
Moves credits from held (reserved) → consumed (debited).
Any unused portion of the hold is automatically released back to the usable balance.
Once fully captured (and remainder released, if any), the hold is considered closed.

Requirement

Requires the authorization_id (i.e., the ledger_operation_id of the original authorize operation).

Note

In case of a partial capture (where the amount held in the authorize call is greater than the amount in the capture call), the remaining held credits are released via a separate internal release operation.
This internal operation is not included in the immediate response, but is visible via the list operations API.
The internal release will have a different ledger_operation_id (system-generated), but will share the same authorization_id as the capture operation for correlation.

The response returns both the created ledger_operation object and the updated ledger_account_balance.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/ledger_operations/capture_authorization

Input Parameters

authorization_id

required, string, max chars=50

Identifier of the original authorize operation whose hold is being captured.

Behavior

Must reference a valid and active hold created via an authorize request.
Must match the ledger_operation_id used in the original authorize call.

optional, string, max chars=50

Optional client-supplied identifier for this capture_authorization operation.

Behavior

When provided, must uniquely identify this operation across the entire ledger.
Should not conflict with any other operation, regardless of type.

amount

required, string, max chars=36

The number of credits to finalize as consumption from a previously authorized (held) amount. Pass this value as a decimal string. Maximum supported value: 9999999999999999999999999.9999999999 (up to 25 digits before the decimal and up to 10 digits after).

Behavior

Must be less than or equal to the current held amount for the specified authorization_id.
The specified amount is moved from held → consumed.

Constraints

Cannot exceed the total credits currently on hold for the authorization.

Example

Step 1: Authorize (hold created): amount = "100" results in 100 credits moved from usable to held.

Step 2: Capture authorization (partial consumption): amount = "70" results in 70 credits moved from held to consumed; remaining 30 credits auto-released back to usable balance (via internal release operation)

Ledger Effect Summary

Consumed: 70
Released: 30
Remaining Hold: 0 (hold closed)

ledger_operation_timestamp

required, timestamp(UTC) in seconds

Unix timestamp (in seconds) representing when the capture_authorization occurred in the upstream system.

Usage

Used for period attribution, grace-period eligibility, and reporting accuracy.

Note

Late or out-of-order submissions appear in arrival order, while attribution and eligibility logic rely on ledger_operation_timestamp.

metadata

optional, jsonobject

Optional opaque JSON object carrying additional business context.

Behavior

Stored as-is and returned verbatim by the system.
Not interpreted, validated, or indexed by the system.

Returns

ledger_operation

Ledger operation object

Resource object representing ledger_operation

ledger_account_balance

Ledger account balance object

Resource object representing ledger_account_balance