Capture charge

Capture a charge that was created with capture: false. You can capture the full amount or a partial amount.

Related endpoints

POST /charges — Create a one-time charge
GET /charges — List charges
GET /charges/{id} — Get charge
POST /charges/{id}/refund — Refund charge

Common errors

400 invalid_request — malformed payload or failed validation.
401 unauthenticated — missing, malformed, or revoked API key.
404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amountMinor?integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://api.revkeen.com/v2/charges/00000000-0000-0000-0000-000000000000/capture" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "amountMinor": 0  }'

{
  "data": {
    "id": "string",
    "customerId": "string",
    "invoiceId": "string",
    "paymentMethodId": "string",
    "amountMinor": 0,
    "amountCapturedMinor": 0,
    "amountRefundedMinor": 0,
    "currency": "str",
    "status": "pending",
    "description": "string",
    "statementDescriptor": "string",
    "failureCode": "string",
    "failureMessage": "string",
    "gatewayTransactionId": "string",
    "receiptUrl": "string",
    "captured": true,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Empty