API Extrato de Conta Corrente Sicredi
O que é esta API
A API de Extrato de Conta Corrente do Sicredi disponibiliza, em tempo real, as movimentações da conta corrente do associado, para integração com ERPs ou sistemas próprios via requisições REST. A consulta retorna os movimentos do período informado, o saldo anterior ao período e o saldo resultante após cada movimento. A autenticação combina mTLS e OAuth2 (client_credentials), no mesmo servidor de autenticação da família Multipag, e o escopo utilizado é contacorrente.extratos.consultar.
Casos de uso principais:
- Conciliação financeira a partir do extrato de conta corrente
- Integração do extrato a ERPs e sistemas de gestão
- Consulta de movimentações da conta por período
Antes de começar
O acesso envolve o cadastro no Portal do Desenvolvedor, a emissão de um certificado digital e a liberação das credenciais OAuth2.
Já integra a API Multipag Pagamentos?Você não precisa de novos certificados nem de novas credenciais. Basta solicitar a inclusão do escopo
contacorrente.extratos.consultarno perfil do seu usuário junto ao Sicredi e enviá-lo na geração do token. Nesse caso, pule direto para o Passo 1.
| Pré-requisito | Como obter | Onde encontrar |
|---|---|---|
| Adesão à API | Manifestar interesse à sua cooperativa e responder ao e-mail de adesão com os dados solicitados | Sua cooperativa Sicredi |
| ID de Adesão | Gerado pelo Sicredi após a análise da solicitação e enviado por e-mail | E-mail enviado pelo Sicredi |
| Cadastro no Portal do Desenvolvedor | Criar conta no Portal utilizando o e-mail informado na adesão | developer.sicredi.com.br |
| Certificado digital e chave privada | Registrar o CSR no Portal do Desenvolvedor. Após a validação pelo Sicredi, baixar o certificado assinado e a chave privada | Portal do Desenvolvedor → Certificados e Credenciais |
| Credenciais (Client ID e Client Secret) | Disponibilizadas pelo Sicredi após a conclusão dos testes em Sandbox | Portal do Desenvolvedor |
Como funciona a adesão:
A liberação do acesso segue as etapas abaixo. Algumas dependem de uma ação sua, outras são conduzidas pelo Sicredi.
| Etapa | O que acontece | O que você faz |
|---|---|---|
| Você comunica à sua cooperativa o interesse em consultar a API | Procure sua cooperativa |
| A cooperativa envia um e-mail para confirmar a adesão e validar o endereço de e-mail | Responda informando cooperativa, conta corrente, CPF ou CNPJ, o e-mail que será usado para acessar o Portal do Desenvolvedor e qual API deseja consultar (Extrato, Saldo ou ambas) |
| O Sicredi analisa a solicitação, valida as informações enviadas e gera o ID de Adesão | Aguardar |
| O Sicredi encaminha um e-mail com o ID de Adesão e as orientações para prosseguir | Guarde o ID de Adesão. Ele será solicitado na etapa 6 |
| O Portal é o canal onde o certificado e as credenciais ficam disponíveis | Acesse developer.sicredi.com.br e crie sua conta com o e-mail informado na adesão |
| O pedido é analisado pelo Sicredi para liberar o catálogo de APIs de Recebimento | No Portal, abra um chamado do tipo "Acesso à API Pix" e informe o ID de Adesão recebido por e-mail |
| O Sicredi analisa e libera o acesso | Aguardar. Após a liberação, acesse APIs → Catálogo de APIs → APIs de Recebimento |
| O CSR é a requisição que dá origem ao seu certificado | Em Certificados e Credenciais, selecione Registrar Novo CSR, preencha os dados solicitados e envie |
| O Sicredi valida o CSR e disponibiliza o certificado assinado | Baixe o certificado e a chave privada no Portal |
| Você recebe a confirmação da liberação, a documentação da API e as orientações para os testes. Nesta etapa, as credenciais de produção ainda não existem | Verifique o e-mail informado no cadastro |
| O ambiente de homologação fica disponível para você validar a integração antes de ir a produção | Realize os testes com base nesta documentação |
| O pedido de produção é feito pelo mesmo canal do e-mail de Boas Vindas | Responda ao e-mail de Boas Vindas informando que os testes foram concluídos e solicitando as credenciais de produção |
| O Sicredi gera as credenciais de produção e avisa por e-mail que já estão disponíveis | Colete o Client ID e o Client Secret no Portal do Desenvolvedor |
Já tem cadastro no Portal?Se você já possui conta no Portal do Desenvolvedor e já tem acesso a APIs → Catálogo de APIs → APIs de Recebimento, siga direto para a etapa 8.
O acesso ao Portal do Desenvolvedor usa o e-mail informado na adesãoSe o técnico responsável for conduzir o processo, o acesso deve ser feito com o e-mail cadastrado na etapa 2.
Chave privada com ou sem frase de segurançaNo download da chave privada, o Portal oferece as duas opções. Se a ferramenta utilizada na integração não suportar chave protegida por senha, utilize a versão sem frase de segurança.
Ambientes disponíveis:
| Ambiente | URL de Autenticação | URL Base da API |
|---|---|---|
| Homologação (Sandbox) | https://mtls-api-parceiro.sicredi.com.br/sb/thirdparty/auth/token | https://mtls-api-parceiro.sicredi.com.br/sb/contacorrente/v1/extratos |
| Produção | https://mtls-api-parceiro.sicredi.com.br/thirdparty/auth/token | https://mtls-api-parceiro.sicredi.com.br/contacorrente/v1/extratos |
Sandbox com dados estáticosO ambiente de homologação usa dados pré-montados, então os exemplos de requisição retornam sempre o mesmo conjunto de dados. Os valores retornados não são dados reais de conta. Em produção, os contratos e rotas são os mesmos, mudando apenas a URL base e os dados do associado e da consulta.
Passo a passo: sua primeira chamada
1. Obter token de acesso
A API usa OAuth2 Client Credentials sobre mTLS. As credenciais vão no corpo da requisição:
curl --location 'https://mtls-api-parceiro.sicredi.com.br/sb/thirdparty/auth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=SEU_CLIENT_ID' \
--data-urlencode 'client_secret=SEU_CLIENT_SECRET' \
--data-urlencode 'scope=contacorrente.extratos.consultar'A chamada exige o certificado mTLS configurado na conexão. O token retornado é do tipo Bearer, com validade de 60 minutos, e deve ser enviado no header Authorization das chamadas seguintes. Quando expirar, requisite um novo token com as mesmas credenciais.
Se você já integra a API Multipag Pagamentos, inclua contacorrente.extratos.consultar junto aos escopos que já utiliza.
2. Consultar o extrato
Consulte as movimentações de um período em /contacorrente/v1/extratos. Os parâmetros vão na query string:
curl --location \
'https://mtls-api-parceiro.sicredi.com.br/sb/contacorrente/v1/extratos?dataInicio=2026-05-20&dataFim=2026-06-30&page=0&size=10' \
--header 'Authorization: Bearer SEU_ACCESS_TOKEN'Parâmetros (query):
dataInicio(yyyy-mm-dd, obrigatório): deve ser menor ou igual adataFimdataFim(yyyy-mm-dd, obrigatório): deve ser maior ou igual adataIniciopage(inteiro): número da página solicitadasize(inteiro): tamanho da página solicitada
Escopo exigido: contacorrente.extratos.consultar.
GET sem corpo de requisiçãoA consulta é um GET e não possui corpo de requisição. Todos os parâmetros são enviados na URL. Atenção ao caminho no plural:
/extratos.
Resposta esperada (200 OK):
{
"saldoAnterior": -500.0,
"dtlMovimentos": [
{
"data": "2026-02-02",
"descricao": "CHEQUE ESPECIAL INAD-IOF",
"complemento": null,
"documento": null,
"valor": -1.27,
"saldo": -501.27,
"codigoLancamento": "262",
"idMovimento": "20260202-3500410-1-1"
}
],
"quantidade": 1,
"totalElements": 1,
"totalPages": 1,
"pageNumber": 0,
"pageSize": 30
}Cada item de dtlMovimentos traz a data, a descrição, o valor do lançamento e o saldo resultante após o movimento. O saldoAnterior é o saldo da conta antes do primeiro movimento do período. Os campos de paginação (totalElements, totalPages, pageNumber, pageSize) apoiam a leitura de extratos longos.
Contas do core legadoPara contas do core legado, movimentos podem ser apresentados em D-1. Considere isso ao comparar o retorno da API com o extrato exibido nos canais.
3. Tratamento de erros
| Status | Significado | Exemplo de detail |
|---|---|---|
400 | Parâmetros inválidos | "A data de inicio não pode ser maior que a data fim" |
401 | Token inválido ou expirado | "Token inválido ou expirado" |
403 | Escopo inapropriado, ou cooperativa e conta inválidos no sandbox | "Privilégios insuficientes" |
500 | Falha no funcionamento da aplicação | Objeto de erro |
Próximos passos
| Tópico | Descrição | Onde encontrar |
|---|---|---|
| Collection Postman | Requisições prontas para teste | Solicite o reenvio pelo Portal do Desenvolvedor, menu Suporte |
| API de Saldo de Conta Corrente | Consulta do saldo atual, valores bloqueados e limites de cheque especial | Documentação da API de Saldo de Conta Corrente |
| Integração com a API Multipag Pagamentos | Reaproveitamento de certificado e credenciais entre as APIs | Documentação da API Multipag |
Precisa de ajuda?
- Portal do desenvolvedor: developer.sicredi.com.br - abertura de chamados via menu Suporte.
- Cooperativa: para questões comerciais e de contratação, procure sua cooperativa Sicredi.
Updated 17 days ago
