RevKeenDocs
StatusSupport
API Reference
💳 Core PaymentsPayment Intents

Capture a payment intent

Captures a payment intent that was created with capture_method=manual and is processing. The card was charged when the intent was confirmed (the gateway takes a sale, not an authorization), so capture does not call the gateway again: it marks the intent succeeded and records the sale transaction, returned as transaction. POST /v2/payment-intents refuses capture_method=manual for now (400 capture_method_unsupported), so an intent created through this API is never capturable.

POST/payment-intents/{id}/capture

Captures a payment intent that was created with capture_method=manual and is processing. The card was charged when the intent was confirmed (the gateway takes a sale, not an authorization), so capture does not call the gateway again: it marks the intent succeeded and records the sale transaction, returned as transaction. POST /v2/payment-intents refuses capture_method=manual for now (400 capture_method_unsupported), so an intent created through this API is never capturable.

Related endpoints

  • POST /payment-intents — Create a payment intent
  • GET /payment-intents — List payment intents
  • GET /payment-intents/{id} — Retrieve a payment intent
  • POST /payment-intents/{id}/confirm — Confirm a payment intent
  • POST /payment-intents/{id}/cancel — Cancel a payment intent

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 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 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

id*string

Payment intent public ID (pi_…) or UUID.

Match^(?:pi_[A-Za-z0-9]+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for capturing a previously authorized payment intent. Specify amount_to_capture for partial captures.

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/payment-intents/pi_abc123/capture" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_to_capture": 1000
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "id": "pi_k3m9x2q7w8e1r4t6",  "object": "payment_intent",  "amount": 5880,  "amount_capturable": 0,  "amount_received": 5880,  "currency": "gbp",  "customer": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",  "description": "INV-0042",  "last_payment_error": null,  "metadata": {},  "next_action": null,  "payment_method": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c65",  "receipt_email": "ada.lovelace@example.com",  "statement_descriptor": "REVKEEN PRO",  "statement_descriptor_suffix": null,  "status": "succeeded",  "capture_method": "automatic",  "client_secret": "pi_k3m9x2q7w8e1r4t6_secret_example",  "canceled_at": null,  "cancellation_reason": null,  "created": 1776333720,  "transaction": "7b8c9d0e-1f2a-4b43-9d4e-5f6a7b8c9d42",  "livemode": true}