commerce
GET /v1/orders/{orderId}/refund-eligibility
Preview an order's refund eligibility.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/refund-eligibility \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
The refund policy's decision for this order without opening a request — whether it is eligible, the amount that would be refunded, and whether it needs staff approval (docs/05 §4.13). Requires `billing.view`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
orderId (path) | Uuid | Ja | The order's id. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
eligible | boolean | Ja | — |
policy_class | RefundPolicyClass | Ja | How the refund policy classified a request (captured at request time). |
requires_approval | boolean | Ja | — |
auto_approved | boolean | Ja | Eligible and needs no human — the money-back path issues immediately. |
amount | MoneyAmount | Ja | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
reason | string | Ja | A customer-safe explanation of the decision. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 429