Representantes

Escopo

A seção Representantes documenta o grupo OpenAPI integracao — rotas sob /api/v1/integracao/**.

Com a API key do representante você pode:

1. Produtores — cadastrar, atualizar, consultar e listar produtores da rede (auto-aprovados na criação via integração).
2. Domicílios bancários — gerenciar contas de recebimento e definir a conta padrão.
3. Saldo — consultar saldo total, bloqueado e disponível para saque.
4. Saques — solicitar (multi-conta + idempotência), listar e cancelar pendentes.
5. Links de pagamento — criar, listar e detalhar links públicos de cobrança.

Fluxo típico

flowchart LR
  Auth[X-API-Key] --> Produtor[Produtor]
  Produtor --> Domicilio[Domicilio bancario]
  Produtor --> Link[Link de pagamento]
  Link --> Saldo[Saldo]
  Saldo --> Saque[Saque]
  Domicilio --> Saque

Campos, obrigatoriedade e exemplos

A fonte de verdade de cada campo (descrição, obrigatório, formato, exemplos) é o OpenAPI gerado pelo backend (@Schema + Bean Validation). Use a referência interativa para o contrato completo.

Os guias desta seção explicam o fluxo de negócio; não duplicam o catálogo de campos.