commerce

GET /v1/orders/{orderId}/payment-options

The payment gateways this order may be settled on.

すべての commerce エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/orders/{orderId}/payment-options \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

What the pay screen offers the customer, so an overdue bill can be settled through whichever enabled gateway they pick rather than only the one the subscription was created with. The answer is **per order, not per platform**. A reseller's client always receives exactly one entry — their reseller's connected gateway — whatever the platform has enabled, because that is the only merchant account their money may land in. `payOrder` refuses any `gateway` that is not in this list. Answers for a settled order too, with the same list: the question "what could pay this?" is meaningful for a receipt, and refusing would make the screen depend on a race with the webhook that settled it.

パラメータ

名前タイプ必須これがその内容です
orderId (path)UuidはいThe order's id.

返信

名前タイプ必須これがその内容です
gatewaysstring[]はいProvider codes (`stripe`, `paypal`, `nowpayments`). Never empty — `stripe` is always present, because an unreadable provider registry must not be reported as "nothing is enabled".

このエンドポイントが返すエラー

401 · 403 · 404 · 429