commerce
GET /v1/payment-options
The payment rails a purchase in this currency may be settled on.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/payment-options?currency=<currency> \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
What the checkout screen offers before anything is bought, so a customer picks how to pay instead of discovering after the fact that only a card was tried. Filtered exactly as getOrderPaymentOptions is, by the same function: a rail the operator has switched off is absent; a rail that cannot present currency is absent (PayPal presents 24 currencies and Indonesian rupiah is not among them); and a reseller's client receives exactly one entry — their reseller's connected gateway — because that is the only merchant account their money may land in. A customer who is suspended or overdue is deliberately not filtered: paying us is how an account stops being suspended. checkoutCart refuses any gateway that is not in this list, so the picker and the charge path read one source.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
currency (query) | CurrencyCode | はい | ISO 4217 code the purchase is priced in. |
org_id (query) | Uuid | いいえ | The organization buying. Omit it and the engine uses the one organization where you hold billing.payment.manage, and refuses when you hold it in more than one — guessing which… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
gateways | string[] | はい | 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 · 422 · 429