agency-invoicing

GET `/v1/agency-invoicing/gateway`

Can you collect online, and through which of your own accounts?

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione agency.invoicing.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/agency-invoicing/gateway \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

⭐ 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`.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`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…

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`established`	`boolean`	Sì	⛔ `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[]`	Sì	—
`can_collect_online`	`boolean`	No	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 429