The Capture endpoint allows you to finalize payments that were authorized but not immediately settled. It’s the second step in the two-step payment process, giving you more control over when funds are captured.
Here’s how it works:
- When to Use It: Only payments created with the capture parameter set to false can be captured. Uncaptured payments remain pending until flagged for settlement.
- Required Parameters:
- Use the paymentId to specify which payment you want to capture.
- If capturing less than the full amount, use the amount parameter to specify the amount in the smallest currency unit (e.g., 100 cents = $1.00).
- Daily Settlement: By default, settlements are run daily for each merchant account, but this endpoint allows you to manually capture payments before that process.
- Secure Access: Always include the key-hash in the headers to protect your data and ensure authorized API usage.
This endpoint is essential for managing payment flows that require a delayed settlement process.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article