commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението billing.payment.manage; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този краен пункт приема org_id като поле в JSON тялото.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
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, за да можете да видите действителния отговор. Отворете този крайpoint в 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 | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 409 · 422 · 429