Capture a payment
Some payment methods, like cards, require a capture request to be sent in order to confirm the authorized balance and to initiate the tranfer of funds.
There are two ways in which captures can be initiated:
- By configuration on the account: all authorized payments will be captured immediately after authorization;
- By API call: a
POST /payments/{payment_id}/capture
including in the body areference
of your own.
{
"reference": "your-capture-reference"
}
A capture is processed asynchronous in the Rootline system and the webhooks will inform you of the outcome.
Capture statuses and webhooks
When you submit a capture through the API, Rootline will handle the capture asynchronous. Rootline will:
- Schedule the capture;
- Submit the capture to the scheme.
Scheduling
Before scheduling the refund Rootline will verify if:
- The payment method supports the capture request;
- The payment has authorized balance to capture.
If the capture is accepted by Rootline you will receive a capture.scheduled
webhook, after which the capture is submitted to the scheme. If scheduling of the capture fails, you will be informed by the capture.scheduled_failed
webhook.