This endpoint is in active development.
Documentation is subject to change. We appreciate your patience, feedback, and partnership as we continue building.
This endpoint is only relevant to Forage SDK integrations.
Instead of calling a front-end SDK method to capture a payment, you can use this endpoint to capture a payment from the backend.
A POST request to /payments/{payment_ref}/capture_payment/ captures an existing Forage Payment.
On success, Forage automatically begins processing the charge to the customer, so this endpoint has immediate financial side effects.
The API responds with a Payment object that represents the transaction and includes complete receipt information.
To keep your app secure, requests to capture a payment should only be generated from the server-side.