RevKeenDocs
StatusSupport
API Reference

Record a payment

Records a manual payment against an invoice. Use this for cash, check, bank transfer, or other offline payments. --- **Related endpoints** - `PUT /invoices/external/batch` — Batch upsert invoices by external ID - `GET /invoices` — List invoices - `POST /invoices` — Create invoice - `GET /invoices/{id}` — Get invoice - `PATCH /invoices/{id}` — Update invoice - `DELETE /invoices/{id}` — Delete invoice - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail - `POST /invoices/{id}/refund` — Refund invoice **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).

POST
/invoices/{id}/pay

Records a manual payment against an invoice. Use this for cash, check, bank transfer, or other offline payments.

Related endpoints

  • PUT /invoices/external/batch — Batch upsert invoices by external ID
  • GET /invoices — List invoices
  • POST /invoices — Create invoice
  • GET /invoices/{id} — Get invoice
  • PATCH /invoices/{id} — Update invoice
  • DELETE /invoices/{id} — Delete invoice
  • POST /invoices/{id}/margin-estimate — Estimate invoice net by payment rail
  • POST /invoices/{id}/refund — Refund invoice

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
Formatuuid

Request Body

application/json

Payment details

TypeScript Definitions

Use the request body type in TypeScript.

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/invoices/00000000-0000-0000-0000-000000000000/pay" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_minor": 10000,
    "payment_method": "bank_transfer",
    "reference": "CHK-12345",
    "notes": "Received via bank wire on Jan 15",
    "paid_at": "2026-01-15T10:30:00Z"
  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customer_uuid": "e7eefd45-cb13-4c62-b229-e5bbc1362123",    "invoice_number": "string",    "total_minor": 0,    "currency": "string",    "allowed_methods": [      "string"    ],    "status": "string",    "due_date": "string",    "custom_fields": {},    "external_source": "string",    "external_type": "string",    "external_id": "string",    "subscription_terms": {      "collection_method": "charge_automatically",      "start_mode": "when_paid",      "start_date": "string",      "duration_type": "until_cancelled",      "duration_count": 1,      "end_date": "string",      "first_payment_behavior": "charge_first_cycle_now"    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "requestId": "string"}

Mark invoices as already delivered POST

Bulk-mark a set of imported invoices as already delivered to customers (e.g., invoices that were emailed by PracticeHub or another external system). Writes `delivered_to_customer_at = NOW()` for each invoice and transitions `imported → approved`. Timestamp is always server-controlled — merchant-supplied backdating is not allowed to prevent reminder-ladder flooding. Request is rejected atomically if any invoice ID does not belong to the authenticated merchant. --- **Related endpoints** - `PUT /invoices/external/batch` — Batch upsert invoices by external ID - `GET /invoices` — List invoices - `POST /invoices` — Create invoice - `GET /invoices/{id}` — Get invoice - `PATCH /invoices/{id}` — Update invoice - `DELETE /invoices/{id}` — Delete invoice - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail - `POST /invoices/{id}/refund` — Refund invoice **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. **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).

Refund invoice POST

Issue a full or partial refund for a paid invoice. Emits invoice.refunded notification to customer. --- **Related endpoints** - `PUT /invoices/external/batch` — Batch upsert invoices by external ID - `GET /invoices` — List invoices - `POST /invoices` — Create invoice - `GET /invoices/{id}` — Get invoice - `PATCH /invoices/{id}` — Update invoice - `DELETE /invoices/{id}` — Delete invoice - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail - `POST /invoices/{id}/reject` — Reject invoice **Common errors** - `400 invalid_request` — malformed payload or failed validation. **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).