commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

Alle commerce Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

NameTypErforderlichWas es ist
refundRequestId (path)UuidJaThe refund request's id.

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusJaA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassJaHow the refund policy classified a request (captured at request time).
amountMoneyAmountJaA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanJaRefund 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…
reasonstringJa
decided_bystringJa
decision_notestringJa
decided_atobjectJa
refund_referencestringJaSet once the refund has been issued (its idempotency key).
created_atstringJa
updated_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429