RevKeen Docs
Api reference

Check credit note eligibility for an invoice

Returns per-payment breakdown of available reversal operations across all gateways. Use this before creating a credit note to understand what reversal methods are available.

Related endpoints

  • GET /credit_notes — List credit notes
  • POST /credit_notes — Create a credit note
  • GET /credit_notes/{id} — Get credit note by ID
  • POST /credit_notes/{id}/void — Void a credit note
  • GET /credit_notes/transaction/{transaction_id}/reversal-eligibility — Check reversal eligibility for a transaction
  • GET /credit_notes/{id}/lines — List line items on a credit note
  • POST /credit_notes/preview — Preview a credit note without creating it

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
/credit_notes/invoice/{invoice_id}/eligibility

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

invoice_id*string

Invoice UUID

Formatuuid

Response Body

application/json

curl "https://api.revkeen.com/v2/credit_notes/invoice/00000000-0000-0000-0000-000000000000/eligibility" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": {
    "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
    "total_amount_minor": 0,
    "total_paid_minor": 0,
    "total_credited_minor": 0,
    "max_creditable_minor": 0,
    "eligible": true,
    "payments": [
      {
        "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
        "gateway": "string",
        "payment_method": "string",
        "amount_minor": 0,
        "amount_refunded_minor": 0,
        "amount_available_minor": 0,
        "card_brand": "string",
        "card_last4": "string",
        "terminal_serial": "string",
        "available_operations": [
          "string"
        ],
        "constraints": {
          "partial_supported": true,
          "requires_card_present": true,
          "requires_terminal_online": true
        }
      }
    ]
  }
}
Empty
Empty
Edit on GitHub