API ReferencePayments
Capture a payment
Captures a previously authorized payment, fully or partially via amount. A partial capture releases the uncaptured remainder.
Authorization
ApiKey X-Api-Key<token>
Merchant API key for authentication
In: header
Path Parameters
id*string
Resource ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/payments/string/capture" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "amount": 1, "currency": "str", "status": "created", "capture_mode": "automatic", "authorized_amount": 0, "captured_amount": 0, "refunded_amount": 0, "disputed_amount": 0, "used_method_family": "string", "used_method_type": "string", "payment_method": { "type": "string", "token": "string" }, "dcc": { "currency": "str", "amount": 0 }, "reference": "string", "description": "string", "customer": { "reference": "string", "email": "string" }, "metadata": { "property1": null, "property2": null }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}