commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
refundRequestId (path) | Uuid | Igen | The refund request's id. |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
note | string | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Igen | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Igen | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Igen | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Igen | Refund destination, frozen at request time — `false` (the default) reverses the original payment, `true` credits the account wallet. Any part of the order that was settled from… |
reason | string | Igen | — |
decided_by | string | Igen | — |
decision_note | string | Igen | — |
decided_at | object | Igen | — |
refund_reference | string | Igen | Set once the refund has been issued (its idempotency key). |
created_at | string | Igen | — |
updated_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 409 · 422 · 429