認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
refundRequestId (path) | Uuid | はい | The refund request's id. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 429