commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
ማረጋገጫ
የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የbilling.payment.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።
የድርጅትዎ መታወቂያ የሚገባበት ቦታ
ይህ ማቆሚያ ነጥብ (endpoint) org_idን በJSON አካል ውስጥ እንደ ሜዳ ይወስዳል።
የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።
ሞክሩት
በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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