commerce

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

Request a refund for an order.

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये billing.payment.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हा एंडपॉइंट JSON बॉडीमधील फील्ड म्हणून org_id घेतो.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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