commerce

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

Request a refund for an order.

அங்கீகாரம்

பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை billing.payment.manage அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.

உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்

இந்த எண்ட்ஸ்பாயிண்ட் JSON பாடியில் உள்ள ஒரு புலமாக org_id-ஐ எடுத்துக்கொள்கிறது.

உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.

முயன்று பார்

கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.

curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்

விவரங்கள்

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