RevKeen Docs
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 unauthenticated — missing, malformed, or revoked API key.

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.

GET
/payments

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

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)

Default20
Range1 <= value <= 100
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

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
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
Edit on GitHub