RevKeenDocs
StatusSupport
API Reference

Retrieve a payment

Retrieves a payment by its ID. --- **Related endpoints** - `GET /payments` — List payments **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.

GET
/payments/{id}

Retrieves a payment by its ID.

Related endpoints

  • GET /payments — List payments

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.

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

Payment ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/payments/00000000-0000-0000-0000-000000000000" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "payment",  "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "status": "pending",  "currency": "string",  "amount": 0,  "amount_captured": 0,  "amount_refunded": 0,  "gateway": "string",  "gateway_transaction_id": "string",  "gateway_response_code": "string",  "gateway_response_text": "string",  "payment_method_type": "string",  "card_brand": "string",  "card_last_four": "string",  "payment_channel": "card_present",  "entry_mode": "emv_chip",  "metadata": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "authorized_at": "2019-08-24T14:15:22Z",  "captured_at": "2019-08-24T14:15:22Z",  "voided_at": "2019-08-24T14:15:22Z",  "refunded_at": "2019-08-24T14:15:22Z"}

Update payment link status PATCH

Change the status of a payment link. Active links accept payments, inactive links are temporarily disabled, and archived links are permanently disabled and cannot be reactivated. --- **Related endpoints** - `POST /payment-links` — Create a new payment link - `GET /payment-links` — List payment links - `GET /payment-links/{id}` — Get payment link by ID - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) **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).

List payments GET

List all payments for the authenticated merchant. Supports filtering and cursor-based pagination. --- **Related endpoints** - `GET /payments/{id}` — Retrieve a payment **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.