RevKeen Docs
Api reference

List terminal payments

List terminal payment attempts for the authenticated merchant. Supports filtering by invoice, status, type, and device. Uses cursor-based pagination.

Related endpoints

  • POST /terminal-payments — Initiate a terminal payment
  • GET /terminal-payments/{id} — Retrieve a terminal payment
  • POST /terminal-payments/{id}/cancel — Cancel a terminal payment
  • POST /terminal-payments/{id}/refund — Refund a terminal payment
  • POST /terminal-payments/{id}/void — Void a terminal 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
/terminal-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

invoice_id?string

Filter by invoice ID

Formatuuid
status?string

Filter by payment status

Value in"requested" | "in_progress" | "approved" | "declined" | "cancelled" | "error" | "timed_out"
type?string

Filter by payment type

Value in"sale" | "refund" | "void"
device_id?string

Filter by device ID

Formatuuid
limit?integer

Maximum number of results (1-100)

Default20
Range1 <= value <= 100
starting_after?string

Cursor for pagination — return results after this terminal payment ID

Formatuuid

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/terminal-payments" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
      "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
      "type": "sale",
      "status": "requested",
      "amount_minor": 0,
      "currency": "string",
      "reference": "string",
      "terminal_serial": "string",
      "uti": "string",
      "auth_code": "string",
      "response_code": "string",
      "rrn": "string",
      "card_scheme": "string",
      "masked_pan": "string",
      "entry_mode": "string",
      "error_message": "string",
      "created_at": "string",
      "completed_at": "string"
    }
  ],
  "meta": {
    "count": 0,
    "limit": 0
  }
}
{
  "error": "string",
  "message": "string",
  "code": "string"
}
Edit on GitHub