Api reference
Check reversal eligibility for a transaction
Returns available reversal operations for a specific payment transaction, including terminal-specific options and NMI fallback paths. For terminal (card-present) transactions, pass customer_present=true to see terminal-native operations.
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/invoice/{invoice_id}/eligibility— Check credit note eligibility for an invoiceGET /credit_notes/{id}/lines— List line items on a credit notePOST /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.
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
transaction_id*string
Transaction UUID
Format
uuidQuery Parameters
customer_present?|
Whether the customer is physically present at the terminal. Enables terminal-native reversal operations.
Default
falseResponse Body
application/json
curl "https://api.revkeen.com/v2/credit_notes/transaction/00000000-0000-0000-0000-000000000000/reversal-eligibility" \ -H "x-api-key: $REVKEEN_API_KEY"{
"data": {
"can_reverse": true,
"transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
"gateway": "string",
"payment_method": "string",
"available_operations": [
"string"
],
"constraints": {
"max_amount": 0,
"partial_supported": true,
"requires_card_present": true,
"requires_terminal_online": true,
"requires_customer_iban": true,
"reason": "string"
},
"card_brand": "string",
"card_last4": "string",
"terminal_serial": "string",
"terminal_uti": "string"
}
}Empty
Empty