agency-invoicing
GET /v1/agency-invoicing/gateway
Can you collect online, and through which of your own accounts?
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão agency.invoicing.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/gateway \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
⭐ 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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
established | boolean | Sim | ⛔ `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[] | Sim | — |
can_collect_online | boolean | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429