RevKeenDocs
StatusSupport
API Reference

Create a payment intent

Creates a payment intent to orchestrate payment collection with support for 3DS/SCA authentication. --- **Related endpoints** - `GET /payment-intents` — List payment intents - `GET /payment-intents/{id}` — Retrieve a payment intent - `POST /payment-intents/{id}` — Update a payment intent - `POST /payment-intents/{id}/confirm` — Confirm a payment intent - `POST /payment-intents/{id}/capture` — Capture a payment intent - `POST /payment-intents/{id}/cancel` — Cancel a payment intent **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. **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).

POST
/payment-intents

Creates a payment intent to orchestrate payment collection with support for 3DS/SCA authentication.

Related endpoints

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

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.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a new payment intent. Specify the amount, currency, customer, and optionally a payment method and capture strategy.

Response Body

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" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5000,
    "currency": "USD",
    "customer": "00000000-0000-0000-0000-000000000000",
    "payment_method": "00000000-0000-0000-0000-000000000000",
    "capture_method": "automatic",
    "description": "string",
    "statement_descriptor": "string",
    "statement_descriptor_suffix": "string",
    "receipt_email": "customer@example.com",
    "metadata": {},
    "gateway_merchant_id": "string"
  }'
{  "id": "string",  "object": "payment_intent",  "amount": 0,  "amount_capturable": 0,  "amount_received": 0,  "currency": "string",  "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",  "description": "string",  "last_payment_error": {    "code": "string",    "message": "string",    "decline_code": "string",    "payment_method": {      "id": "string",      "type": "string"    }  },  "metadata": {},  "next_action": {    "type": "redirect_to_url",    "redirect_to_url": {      "url": "http://example.com",      "return_url": "http://example.com"    }  },  "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",  "receipt_email": "user@example.com",  "statement_descriptor": "string",  "statement_descriptor_suffix": "string",  "status": "requires_payment_method",  "capture_method": "automatic",  "client_secret": "string",  "canceled_at": "2019-08-24T14:15:22Z",  "cancellation_reason": "duplicate",  "created": 0,  "livemode": true}

Confirm a payment intent POST

Confirms the payment intent. May return requires_action if 3DS authentication is needed. --- **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}` — Update a payment intent - `POST /payment-intents/{id}/capture` — Capture 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](/docs/fundamentals/idempotency).

Retrieve a payment intent GET

Retrieves a payment intent by its ID (pi_xxx). --- **Related endpoints** - `POST /payment-intents` — Create a payment intent - `GET /payment-intents` — List payment intents - `POST /payment-intents/{id}` — Update a payment intent - `POST /payment-intents/{id}/confirm` — Confirm a payment intent - `POST /payment-intents/{id}/capture` — Capture a payment intent - `POST /payment-intents/{id}/cancel` — Cancel a payment intent **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.