commerce

POST `/v1/refund-requests/{refundRequestId}/approve`

Approve a pending refund request (staff).

प्रमाणन

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

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

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

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

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

विवरण

Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the billing.refund permission held by a staff role, not by any customer role.

पैरामीटर

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

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`note`	`string`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`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/refund-requests/{refundRequestId}/approve