agency-invoicing

POST `/v1/agency-invoicing/portal/{token}/checkout`

Start a payment on the AGENCY's own gateway. Unauthenticated.

Autenticação

Este endpoint é público. Ele não requer credenciais nem organização — é o que nosso próprio site de marketing e os mecanismos de resposta de IA leem.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

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 POST https://api.zinndigital.com/v1/agency-invoicing/portal/{token}/checkout \
  -H "Content-Type: application/json" \
  -d '{  }'

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 money settles into the **agency's** merchant account and never touches Zinn®'s balance. An agency with no connected gateway gets a `409` — there is no fallback, because there is no relationship under which we could take money for a document our name is nowhere near. Returns a `client_token` for a browser SDK, a `redirect_url` for an approval or hosted-invoice rail, or a completed capture.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`token (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`provider`	`string`	Não	Which of the agency's connected gateways to use. Their default when omitted.

Resposta

Nome	Tipo	Obrigatório	O que é
`status`	`string`	Sim	`captured` when the rail settled synchronously, `pending` for a crypto invoice or an unconfirmed intent, `requires_action` for 3-D Secure.
`provider_code`	`string`	Não	—
`client_token`	`string`	Não	A short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere.
`redirect_url`	`string`	Não	Where to send the payer for rails that use an approval or hosted page.
`action_kind`	`string<authenticate, approve, pay, add_payment_method>`	Não	—
`amount_minor`	`integer`	Sim	—
`currency`	`string`	Sim	—

Erros que este endpoint pode retornar

404 · 409 · 429 · 503

POST /v1/agency-invoicing/portal/{token}/checkout