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}/refund — Refund invoice
POST /invoices/{id}/reject — Reject 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 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

Payment details

TypeScript Definitions

Use the request body type in TypeScript.

amount_minor?integer

Payment amount in minor units (cents). If not provided, pays the full amount due.

Range0 < value

payment_method?string

The payment method used

Default"other"

Value in"cash" | "check" | "bank_transfer" | "other"

reference?string

External reference (check number, transfer ID, etc.)

Lengthlength <= 255

notes?string

Additional notes about the payment

Lengthlength <= 1000

paid_at?string

When the payment was received (defaults to now)

Formatdate-time

Response Body

`application/json`

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": "practicehub",
    "external_type": "appointment",
    "external_id": "INV-12345",
    "subscription_terms": {
      "collection_method": "charge_automatically",
      "start_mode": "when_paid",
      "start_date": "string",
      "duration_type": "until_cancelled",
      "duration_count": 12,
      "end_date": "string",
      "first_payment_behavior": "charge_first_cycle_now"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "requestId": "string"
}

Empty