reseller
POST /v1/reseller/gateways/{code}
Connect or re-key your own payment gateway.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/reseller/gateways/{code} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "values": <object> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The credentials are checked against the provider with a real authenticated call before anything is stored, then written to Vault — never to a database row, a log line, an audit entry or an error message. With validate_only the check runs and nothing is stored, returning 200 even when the credentials are rejected, because that is the answer being asked for. Requires reseller.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
code (path) | string | はい | The gateway code — stripe, paypal or nowpayments. |
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
values | object | はい | {settings_key: value} for the fields the gateway declares. Written to Vault, never to a database row, a log line, an audit entry or an error message (CLAUDE.md §2.4). |
mode | string<test, live> | いいえ | — |
validate_only | boolean | いいえ | Check the credentials and return the result without storing. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
healthy | boolean | はい | — |
detail | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503