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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `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](/docs/fundamentals/idempotency).
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 chargeGET /charges— List chargesGET /charges/{id}— Get chargePOST /charges/{id}/refund— Refund charge
Common errors
400 invalid_request— malformed payload or failed validation.401 authentication_error— missing, invalid, expired, or revoked credential. Codes:authentication_failed,invalid_api_key,expired_api_key,api_key_revoked,session_invalid,merchant_required. Carries aWWW-Authenticate: Bearerchallenge.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.
Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.
In: header
Path Parameters
uuidRequest 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://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" }}Update a line item's quantity PATCH
Change the quantity of a single line item on an open cart. Other fields on the line item are immutable; recreate the item to change them. --- **Related endpoints** - `POST /cart-sessions` — Create a cart session - `GET /cart-sessions/{id}` — Retrieve a cart session - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
Create a one-time charge POST
Create a one-time charge for an existing customer. This is for ad-hoc charges like setup fees, overages, or one-time services. For recurring billing, use subscriptions instead. The charge will be processed immediately using the customer's default payment method, unless a specific payment method ID is provided. --- **Related endpoints** - `GET /charges` — List charges - `GET /charges/{id}` — Get charge - `POST /charges/{id}/capture` — Capture charge - `POST /charges/{id}/refund` — Refund charge **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).