commerce

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

Request a refund for an order.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს billing.payment.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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

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