인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 billing.payment.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 ID가 들어가는 위치
이 엔드포인트는 JSON 본문의 필드로 org_id을(를) 받습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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_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