RevKeen Docs
Api reference

Retrieve a payment

Retrieves a payment by its ID.

Related endpoints

  • GET /payments — List payments

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/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

Payment ID

Formatuuid

Response Body

application/json

application/json

application/json

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