agency-invoicing
GET /v1/agency-invoicing/gateway
Can you collect online, and through which of your own accounts?
認証
ベアラー トークンとして API キーを送信します。キーには agency.invoicing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/gateway \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⭐ The answer to a silent failure. An agency with no connected gateway gets a payment portal that refuses every payment — correctly, because the money would otherwise settle somewhere it does not belong — and nothing else on the platform says so. ⛔ `established: false` means we could not look, which is NOT the same as "you have none": the second is actionable and the first is ours to fix. Requires `agency.invoicing.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
established | boolean | はい | ⛔ `false` means we could NOT look, which is not the same fact as "you have none" — one is ours to fix and the other is yours. A screen must not render them the same way. |
gateways | object[] | はい | — |
can_collect_online | boolean | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429