API Docs Início Documentação Referência de API Copiar para LLM
Referência de API · Cobrança

Contrato de Cobrança, campo a campo.

61 endpoints organizados pelo fluxo de integração. Cada endpoint traz método, rota, campos de request e response campo a campo e o exemplo de chamada em cURL, C# e JavaScript, gerados do contrato.

61
Endpoints
5
Etapas do fluxo
3
Linguagens de exemplo
Como usar esta referência. Siga as etapas do fluxo no menu à esquerda. Cada endpoint traz um cURL pronto para colar no terminal ou importar no Postman (Import > Raw text). Use os placeholders {{baseUrl}} e {{token}}, compatíveis com variáveis de environment do Postman.
Copiar para LLM→Baixar referência (.md)→Como importar no Postman→

Baixe a collection e importe no Postman (Import > File). As variáveis {{baseUrl}} e {{token}} já vêm declaradas no nível da collection.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads

Fluxo de integração

As etapas abaixo seguem a ordem típica de uma integração. Abra uma etapa no menu à esquerda para ver seus endpoints — todos os grupos iniciam fechados.

EtapaO que fazerEndpoints
1. CarteirasConvênios de cobrança dos cedentes; base para emitir boletos.9
2. BoletosEmita, consulte, baixe e cancele boletos bancários.20
3. CobrançasGerencie cobranças e seus dados ao longo do ciclo.15
4. ParcelamentosCrie e acompanhe parcelamentos de cobranças.13
5. BeneficiáriosBeneficiários que recebem os valores das cobranças.4