RevKeen Docs
Api reference

Retrieve a terminal payment

Get a terminal payment attempt by ID.

Related endpoints

  • POST /terminal-payments — Initiate a terminal payment
  • GET /terminal-payments — List terminal payments
  • 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

  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/terminal-payments/{id}

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

Path Parameters

id*string

Terminal payment attempt ID

Formatuuid

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/terminal-payments/00000000-0000-0000-0000-000000000000" \  -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"
  }
}
{
  "error": "string",
  "message": "string",
  "code": "string"
}
Edit on GitHub