commerce
POST /v1/orders/{orderId}/paypal/capture
Capture a PayPal order the buyer completed.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/paypal/capture \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "paypal_order_id": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Settles the order against a PayPal order the buyer has approved (wallet) or paid by card (including any 3-D Secure step). ⛔ **The browser is not believed.** It reports that the buyer finished; only PayPal's capture response says money moved, and only the engine writes a payment. Posting an invented `paypal_order_id` produces a gateway error, never a paid order. A **declined card answers 200** with the order `payment_failed`, for the same reason `payOrder` does — the attempt was processed exactly as asked.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
orderId (path) | Uuid | はい | The order's id. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
paypal_order_id | string | はい | The id returned by `openPayPalOrder` and completed in the browser. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | はい | Human-friendly order reference. |
status | OrderStatus | はい | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | はい | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | はい | — |
tax_minor | integer | はい | — |
discount_minor | integer | はい | — |
total_minor | integer | はい | — |
billing_country | object | いいえ | — |
placed_at | object | いいえ | — |
created_at | string | はい | — |
updated_at | string | いいえ | — |
lines | OrderLine[] | はい | — |
payments | Payment[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503