commerce

POST /v1/orders/{orderId}/refund-request

Request a refund for an order.

Све commerce крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу billing.payment.manage; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка узима 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 конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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_idUuidНеUUIDv7 identifier — sortable by creation time (docs/02 §8).
reasonstringНе—
to_walletbooleanНе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…

Одговор

НазивТипОбавезноШта је ово
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 · 409 · 422 · 429