commerce

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

Request a refund for an order.

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပို့ပါ။ သော့တွင် billing.payment.manage ခွင့်ပြုချက် ပါရှိရမည်ဖြစ်ပြီး၊ ၎င်းမပါရှိသော သော့ကို 404 အစား 403 ဖြင့် ငြင်းပယ်ပါမည်။

သင့်အဖွဲ့အစည်း၏ 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 ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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…

တုံ့ပြန်ချက်

နာမည်	အမျိုးအစား	လိုအပ်သည်	ဘာလဲဆိုတာ
`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