commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

Tutti gli endpoint commerce

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.

Parametri

NomeTipoObbligatorioChe cos'è
refundRequestId (path)UuidThe refund request's id.

Risposta

NomeTipoObbligatorioChe cos'è
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassHow the refund policy classified a request (captured at request time).
amountMoneyAmountA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanRefund 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…
reasonstring
decided_bystring
decision_notestring
decided_atobject
refund_referencestringSet once the refund has been issued (its idempotency key).
created_atstring
updated_atstring

Errori che questo endpoint può restituire

401 · 403 · 404 · 429