Capture a Payment
The PayHere Capture API allows you to capture your authorized Hold on Card payments on demand.
Endpoint
http
POST /payhere/api/payments/capture
Required Parameters
authorization_token
: Use theauthorization_token
retrieved from the Authorize API in the request body.amount
: The amount to capture.description
: Additional details about the capture request.
Request Body
This request body is copied from the official PayHere knowledge base.
json
{
"authorization_token": "e34f3059-7b7d-4b62-a57c-784beaa169f4",
"amount": 80.0,
"deduction_details": "Item1 is out of stock"
}
Response
This response is copied from the official PayHere knowledge base.
json
{
"status": 1,
"msg": "Successfully captured payment",
"data": {
"status_code": 2,
"status_message": "Successfully received the VISA payment",
"payment_id": 320025527952,
"currency": "LKR",
"amount": 100.0,
"captured_amount": 80.0,
"items": "Toy Car",
"order_id": "Order12345",
"md5sig": "27EE69A66E761D20429984A0CB0AFC27",
"custom_1": "ABCD",
"custom_2": null
}
}