Payments
API ReferencePaymentsApprove
Approve Payment
Approves a payment that was held for manual review by a fraud or risk decision rule. The payment proceeds to capture (or remains in the configured capture flow) once approved.
POST /payments/:payment_id/approve
This endpoint takes no request body. The path parameter is the only input.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
payment_id | string | Yes | The ID of the payment to approve. The payment must be in a manual-review state. |
Request Example
curl -X POST 'https://api.v2.paychtec.com/payments/pay_1234567890abcdef/approve' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY"Response
{
"payment_id": "pay_1234567890abcdef",
"status": "succeeded",
"amount": 6540,
"currency": "USD",
"captured_at": "2024-01-22T14:00:00Z"
}Errors
| Status | When |
|---|---|
400 | Payment is not in a state that can be approved (e.g. already settled or cancelled). |
404 | Payment id does not exist. |