commerce

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

Request a refund for an order.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास billing.payment.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

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

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`orderId (path)`	`Uuid`	हाँ	The order's id.

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`org_id`	`Uuid`	नहीं	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`reason`	`string`	नहीं	—
`to_wallet`	`boolean`	नहीं	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…

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`RefundRequestStatus`	हाँ	A refund request's lifecycle state (docs/05 §4.13).
`policy_class`	`RefundPolicyClass`	हाँ	How the refund policy classified a request (captured at request time).
`amount`	`MoneyAmount`	हाँ	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`to_wallet`	`boolean`	हाँ	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`	हाँ	—
`decided_by`	`string`	हाँ	—
`decision_note`	`string`	हाँ	—
`decided_at`	`object`	हाँ	—
`refund_reference`	`string`	हाँ	Set once the refund has been issued (its idempotency key).
`created_at`	`string`	हाँ	—
`updated_at`	`string`	हाँ	—

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 409 · 422 · 429

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