RevKeenDocs
StatusSupport
API Reference
💳 Core PaymentsRefunds

Create a refund

Initiate a refund for a payment. The refund will be processed through the original payment gateway.

POST/refunds

Initiate a refund for a payment. The refund will be processed through the original payment gateway.

Related endpoints

  • GET /refunds — List refunds
  • GET /refunds/{id} — Get refund by ID

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.
  • 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.
  • 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.

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

Scope: refunds:write

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a refund. Name the sale with exactly one of payment_id, transaction or payment_intent, and optionally a partial amount.

Response Body

application/json

application/json

application/json

application/json

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/refunds" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_id": "11111111-1111-4111-8111-111111111111",
    "amount_minor": 5000,
    "reason": "customer_request",
    "reason_details": "Customer requested refund via support ticket #12345"
  }'

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

{  "data": {    "id": "1b2c3d4e-5f6a-4b87-9c98-0d1e2f3a4b86",    "public_id": "ref_example_7k2m",    "payment_id": "7b8c9d0e-1f2a-4b43-9d4e-5f6a7b8c9d42",    "parent_transaction_id": "7b8c9d0e-1f2a-4b43-9d4e-5f6a7b8c9d42",    "order_id": null,    "gateway": "nmi",    "gateway_refund_id": "10482739012",    "amount_minor": 1176,    "currency": "GBP",    "reason": "customer_request",    "reason_details": "Goodwill credit: one week of the Pro plan.",    "status": "succeeded",    "failure_reason": null,    "failure_code": null,    "processed_at": "2026-04-20T14:31:00.000Z",    "created_at": "2026-04-20T14:30:00.000Z"  }}