commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

सभी commerce एंडपॉइंट्स

प्रमाणन

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

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

इसे आज़माएँ

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

curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

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

विवरण

Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.

पैरामीटर

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

प्रतिक्रिया

नामप्रकारआवश्यकयह क्या है
idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusहाँA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassहाँHow the refund policy classified a request (captured at request time).
amountMoneyAmountहाँA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanहाँ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…
reasonstringहाँ
decided_bystringहाँ
decision_notestringहाँ
decided_atobjectहाँ
refund_referencestringहाँSet once the refund has been issued (its idempotency key).
created_atstringहाँ
updated_atstringहाँ

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

401 · 403 · 404 · 429