commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
refundRequestId (path) | Uuid | はい | The refund request's id. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
note | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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