commerce

POST `/v1/orders/{orderId}/refund-request`

Request a refund for an order.

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu billing.payment.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

Opens a refund request per the policy: within the 30-day money-back window the refund is issued immediately (status `auto_approved`); otherwise a pro-rata request is recorded `pending` for staff approval (docs/05 §4.13). The amount and approval path come from the server, never the client. Requires `billing.payment.manage`.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`orderId (path)`	`Uuid`	Da	The order's id.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`org_id`	`Uuid`	Ne	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`reason`	`string`	Ne	—
`to_wallet`	`boolean`	Ne	Where the refund goes. Omit it and the money is returned to the original payment method — the money-back guarantee is money back, and store credit is an opt-in the customer has…

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`RefundRequestStatus`	Da	A refund request's lifecycle state (docs/05 §4.13).
`policy_class`	`RefundPolicyClass`	Da	How the refund policy classified a request (captured at request time).
`amount`	`MoneyAmount`	Da	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`to_wallet`	`boolean`	Da	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`	Da	—
`decided_by`	`string`	Da	—
`decision_note`	`string`	Da	—
`decided_at`	`object`	Da	—
`refund_reference`	`string`	Da	Set once the refund has been issued (its idempotency key).
`created_at`	`string`	Da	—
`updated_at`	`string`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 409 · 422 · 429