agency-invoicing

GET `/v1/agency-invoicing/gateway`

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie agency.invoicing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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

Naam	Type	Verplicht	Wat dit is
`org_id (query)`	`Uuid`	Nee	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…

Reactie

Naam	Type	Verplicht	Wat dit is
`established`	`boolean`	Ja	⛔ `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[]`	Ja	—
`can_collect_online`	`boolean`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429