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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
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 notesPOST /credit_notes— Create a credit noteGET /credit_notes/{id}— Get credit note by IDPOST /credit_notes/{id}/void— Void a credit noteGET /credit_notes/transaction/{transaction_id}/reversal-eligibility— Check reversal eligibility for a transactionGET /credit_notes/{id}/lines— List line items on a credit notePOST /credit_notes/preview— Preview a credit note without creating it
Common errors
401 authentication_error— missing, invalid, expired, or revoked credential. Codes:authentication_failed,invalid_api_key,expired_api_key,api_key_revoked,session_invalid,merchant_required. Carries aWWW-Authenticate: Bearerchallenge.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.
In: header
Path Parameters
Invoice UUID
uuidResponse Body
application/json
application/json
application/json
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 } } ] }}Get credit note by ID GET
Retrieve a single credit note by its UUID. --- **Related endpoints** - `GET /credit_notes` — List credit notes - `POST /credit_notes` — Create a credit note - `POST /credit_notes/{id}/void` — Void a credit note - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice - `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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
List line items on a credit note GET
Returns the line items attached to a credit note. Each line describes a portion of the invoice that the credit applies to — either a whole invoice line or a prorated slice. Use this to reconstruct the credit's effect per invoice line (for example, when displaying the credit breakdown in your own UI). --- **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/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction - `POST /credit_notes/preview` — Preview a credit note without creating it **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.