Capture a payment
Learn how to collect a pre-authorized payment with the Dojo Payments API.
A created pre-authorized payment isn't complete until it has been captured. When completing a payment, you can capture the amount in full, or in partial increments.
You can only capture a payment that hasn't yet been refunded or reversed.
Capture using the Dojo API
To capture a payment, use the endpoint:
POST /payment-intents/{paymentIntentId}/captures
In your request, include:
-
paymentIntentId: This identifies the payment intent to be captured. -
amount: This is the amount to capture.
For the full API specification, see the reference.
Request example
The next example shows the capture of 10.00 GBP.
- cURL
- PowerShell
- Python
- C#
- PHP
manage-payments/curl/capture.sh
loading...
manage-payments/powershell/capture.ps1
loading...
manage-payments/python/capture.py
loading...
manage-payments/cs/capture.cs
loading...
manage-payments/php/capture.php
loading...
Response example
If your request is successful, the response will return information about the capture.
{
"message": "collect payment for the order 3443",
"captureId": "cp_itIiJMEAvES3ynYF_Yhs2g"
}