commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි billing.payment.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්රතික්ෂේප කෙරේ.
ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය
මෙම අවසාන ලක්ෂ්යය JSON ශරීරයේ ක්ෂේත්රයක් ලෙස org_id ලබා ගනී.
ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ 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 වෙත ඉල්ලීම ක්රියාත්මක කරන බැවින් ඔබට සැබෑ ප්රතිචාරය දැකගත හැක. මෙම අග්රලක්ෂ්යය 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 to… |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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