agency-invoicing
GET /v1/agency-invoicing/gateway
Can you collect online, and through which of your own accounts?
Authentication
Send an API key as a bearer token. The key must carry the agency.invoicing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/gateway \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⭐ 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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
established | boolean | Yes | ⛔ `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[] | Yes | — |
can_collect_online | boolean | No | — |
Errors this endpoint can return
401 · 403 · 404 · 429