RevKeenDocs
StatusSupport
API Reference

List payments

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.

GET
/payments

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 for SDK auto-paging helpers.

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

Query Parameters

customer_id?string

Filter by customer ID

Formatuuid
invoice_id?string

Filter by invoice ID

Formatuuid
status?string

Filter by status

Value in

  • "pending"
  • "authorized"
  • "captured"
  • "succeeded"
  • "failed"
  • "voided"
  • "refunded"
  • "partially_refunded"
payment_channel?string

Filter by payment channel. Use card_present for terminal payments, card_not_present for online payments.

Value in

  • "card_present"
  • "card_not_present"
  • "bank_transfer"
  • "manual"
created_gte?|

Filter by created_at >= (Unix timestamp)

created_lte?|

Filter by created_at <= (Unix timestamp)

limit?integer

Maximum number of results (1-100)

Range1 <= value <= 100
Default20
starting_after?string

Cursor for pagination - return results after this ID

Formatuuid
ending_before?string

Cursor for pagination - return results before this ID

Formatuuid

Response Body

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" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "object": "list",  "data": [    {      "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"    }  ],  "has_more": true,  "total_count": 0}

Retrieve a payment GET

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 payout by ID GET

Retrieve a single payout by its public ID (pyt_xxx) or internal UUID. --- **Related endpoints** - `GET /payouts` — List payouts - `GET /payouts/{id}/payments` — Get payments in a payout **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.