API Saldo de Conta Corrente Sicredi

O que é esta API

A API de Saldo de Conta Corrente do Sicredi disponibiliza, em tempo real, os saldos da conta corrente do associado, para integração com ERPs ou sistemas próprios via requisições REST. A consulta é síncrona e retorna o saldo atual da conta, os valores bloqueados (inclusive bloqueio judicial) e os limites de cheque especial. A autenticação combina mTLS e OAuth2 (client_credentials), no mesmo servidor de autenticação da família Multipag, e o escopo utilizado é contacorrente.saldo.consultar.

Casos de uso principais:

• Consulta de saldo de conta corrente em tempo real
• Integração do saldo a ERPs e sistemas de gestão
• Acompanhamento de saldo disponível, valores bloqueados e limite de cheque especial

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.

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.

Ambientes disponíveis:

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.saldo.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 ou a API de Extrato, inclua contacorrente.saldo.consultar junto aos escopos que já utiliza.

2. Consultar o saldo

Consulte os saldos da conta em /contacorrente/v1/saldos. Esta consulta não recebe parâmetros: ela retorna o saldo da conta vinculada à credencial.

curl --location \
  'https://mtls-api-parceiro.sicredi.com.br/sb/contacorrente/v1/saldos' \
  --header 'Authorization: Bearer SEU_ACCESS_TOKEN' \
  --header 'accept: application/json'

Escopo exigido: contacorrente.saldo.consultar.

Resposta esperada (200 OK):

{
  "saldoAtual": 931151.27,
  "saldoContaCorrente": 400,
  "saldoAplicAutomatica": 0.00,
  "saldoBloqueadoParaCheques": 0,
  "saldoLancamentosAConferir": 0,
  "saldoBloqueioJudicial": 0,
  "saldoRetido": 0,
  "limiteChequeEspecial": 400,
  "limiteChequeEspecialUtilizado": 0,
  "limiteChequeEspecialDisponivel": 400
}

Os campos cobrem três grupos: o saldo em si (saldoAtual, saldoContaCorrente, saldoAplicAutomatica), os valores retidos ou bloqueados (saldoBloqueadoParaCheques, saldoLancamentosAConferir, saldoBloqueioJudicial, saldoRetido) e os limites de cheque especial (limiteChequeEspecial, limiteChequeEspecialUtilizado, limiteChequeEspecialDisponivel).

3. Tratamento de erros

Próximos passos

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.