Capture a payment

The Unified Payments API supports multiple partial captures—enabling you to process your capture requests at the same time as your split shipments.

If a payment is requested with capture as false, you can use this endpoint to capture the payment. These captures can either be the full or partial authorization amount, but cannot be submitted for a combined amount that exceeds the total authorized balance. If you don't capture it within seven days, the payment is voided.

Any capture amount less than the original payment will be treated as a partial capture.

To perform multiple partial captures, capture_type should be set to NonFinal. The default value is Final, which will make any remaining amount on partial captures void.

Use the details below to set up your request.

For the full API specification, see the API reference.

json
1{
2  "amount": 100,
3  "reference": "ORD-752-814",
4  "capture_type": "Final"
5}

If you receive a 202 HTTP status code, your capture request has been submitted successfully for clearing.