commerce

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

Request a refund for an order.

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin billing.payment.manage; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Inda ID ɗin kungiyar ku ke zuwa

Wannan ma'ajiyar tana karɓar org_id a matsayin fili a cikin jikin JSON.

Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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`.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`orderId (path)`	`Uuid`	Eh	The order's id.

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`org_id`	`Uuid`	A'a	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`reason`	`string`	A'a	—
`to_wallet`	`boolean`	A'a	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…

Martani

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

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 404 · 409 · 422 · 429