RevKeenDocs
StatusSupport
API Reference

Create a refund

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. **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
/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.

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 refund. Specify the transaction ID and optionally a partial amount.

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/refunds" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_id": "660e8400-e29b-41d4-a716-446655440000",
    "amount_minor": 5000,
    "reason": "customer_request",
    "reason_details": "Customer requested refund via support ticket #12345"
  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "public_id": "string",    "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",    "parent_transaction_id": "2862f816-fb62-4845-833b-6951bbef56b3",    "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",    "gateway": "string",    "gateway_refund_id": "string",    "amount_minor": 0,    "currency": "string",    "reason": "customer_request",    "reason_details": "string",    "status": "pending",    "failure_reason": "string",    "failure_code": "string",    "processed_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z"  }}

Update product PATCH

Update an existing product. Requires 'products:write' scope. --- **Related endpoints** - `GET /products` — List products - `POST /products` — Create product - `GET /products/{id}` — Get product by ID - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID - `PUT /products/external/batch` — Batch upsert products by external 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. - `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).

Get refund by ID GET

Retrieve a single refund by its public ID (ref_xxx) or internal UUID. --- **Related endpoints** - `GET /refunds` — List refunds - `POST /refunds` — Create a refund **Common errors** - `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. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.