commerce

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

Request a refund for an order.

ການພິສູດຕົວຕົນ

ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ billing.payment.manage; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.

ບ່ອນທີ່ລະບົບຈັດການອົງກອນຂອງທ່ານໄປ

ຈຸດສິ້ນສຸດນີ້ຮັບເອົາ org_id ເປັນຊ່ອງຂໍ້ມູນໃນ JSON body.

ລະຫັດອົງກອນຂອງທ່ານແມ່ນຢູ່ໜ້າກະແຈ API ໃນແຜງຄວບຄຸມຂອງທ່ານ, ຖັດຈາກກະແຈ itself. ມັນແມ່ນລະຫັດດຽວກັນໃນທຸກໆການໂທທີ່ທ່ານເຮັດ.

ລອງໃຊ້ເບິ່ງ

ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.

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 ຕົວຈິງ ເພື່ອໃຫ້ທ່ານສາມາດເຫັນຜົນຕອບຮັບທີ່ແທ້ຈິງໄດ້. ເປີດຈຸດສິ້ນສຸດນີ້ໃນຄອນໂສລ 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