RevKeenDocs
StatusSupport
API Reference

Refund charge

Refund a charge. You can refund the full amount or specify a partial refund amount. Multiple partial refunds can be issued until the full amount is refunded. --- **Related endpoints** - `POST /charges` — Create a one-time charge - `GET /charges` — List charges - `GET /charges/{id}` — Get charge - `POST /charges/{id}/capture` — Capture charge **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).

POST
/charges/{id}/refund

Refund a charge. You can refund the full amount or specify a partial refund amount. Multiple partial refunds can be issued until the full amount is refunded.

Related endpoints

  • POST /charges — Create a one-time charge
  • GET /charges — List charges
  • GET /charges/{id} — Get charge
  • POST /charges/{id}/capture — Capture charge

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.

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

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/charges/00000000-0000-0000-0000-000000000000/refund" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amountMinor": 0,
    "reason": "duplicate",
    "notes": "string"
  }'
{  "data": {    "id": "string",    "customerId": "string",    "invoiceId": "string",    "paymentMethodId": "string",    "amountMinor": 0,    "amountCapturedMinor": 0,    "amountRefundedMinor": 0,    "currency": "str",    "status": "pending",    "description": "string",    "statementDescriptor": "string",    "failureCode": "string",    "failureMessage": "string",    "gatewayTransactionId": "string",    "receiptUrl": "string",    "captured": true,    "metadata": {      "property1": null,      "property2": null    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

List charges GET

Retrieve a paginated list of charges with optional filtering by customer, status, or date range. --- **Related endpoints** - `POST /charges` — Create a one-time charge - `GET /charges/{id}` — Get charge - `POST /charges/{id}/capture` — Capture charge - `POST /charges/{id}/refund` — Refund charge **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. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Create a checkout session POST

Create a checkout session for an invoice or product. --- **Related endpoints** - `GET /checkout-sessions/{id}` — Retrieve a checkout session - `POST /checkout-sessions/{id}/expire` — Expire a checkout session **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).