API Docs
Início
Documentação
Referência de API
Copiar para LLM
Referência de API · Banking
Contrato de Banking, campo a campo.
139 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.
139
Endpoints
7
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.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.
| Etapa | O que fazer | Endpoints |
|---|---|---|
| 1. Chaves PIX | Cadastre e gerencie as chaves PIX da conta. | 10 |
| 2. PIX | Pagamentos instantâneos: envio, QR Code e devoluções. | 46 |
| 3. Transferências | Transferências entre contas (TED e pagamentos). | 24 |
| 4. Limites | Consulte e ajuste limites operacionais da conta. | 4 |
| 5. Operadores | Operadores autorizados a movimentar a conta. | 11 |
| 6. Favorecidos | Favorecidos para pagamentos e transferências. | 7 |
| 7. Conta digital | Abertura, saldo, extrato e gestão da conta digital. | 37 |