A capture settles a previously authorised payment, collecting the reserved funds from the customer's payment method.
Auth / Capture Flow
When you create a payment with action: AUTH, funds are reserved (held) on the customer's card but not collected. You then have a window (typically 7-30 days depending on the processor) to capture the funds:
- Create payment with
action: AUTH: funds are reserved - Capture the authorisation: funds are collected
- Or void the authorisation: funds are released
This flow is common in scenarios where you need to verify funds before fulfilment, such as e-commerce orders that ship later.
Partial and Multi-Capture
You can capture less than the full authorised amount. Some gateways also support multi-capture, where you capture in multiple instalments up to the total authorised amount (e.g., authorise $100, capture $20, then later capture $80). Multi-capture support varies by gateway.
Status
| Status | Description |
|---|---|
SUCCESS | The capture was processed successfully |
PENDING | The capture is still being processed |
DECLINED | The capture was declined by the gateway |
UNRESOLVED | No conclusive result received from the gateway |