API Multipag Sicredi

O que é esta API

A API Multipag do Sicredi permite integrar sistemas próprios ou ERPs aos serviços de pagamento do Sicredi, pagamento de boletos, tributos e contas de consumo com código de barras, e transferências via Pix (por chave ou dados bancários), por meio de requisições REST. A criação do pagamento tem resposta síncrona (sucesso/falha na solicitação), mas a efetivação só ocorre após aprovação em canal digital e é assíncrona, o status final chega via Webhook ou consulta. Disponível 24 horas, 7 dias por semana, seguindo os padrões de segurança do BACEN.

Casos de uso principais:

• Pagamento de boletos com código de barras
• Pagamento de tributos e contas de consumo com código de barras (incluindo FGTS)
• Transferências via Pix por chave ou dados bancários
• Agendamento e cancelamento de pagamentos
• Consulta de status e obtenção de comprovantes
• Recebimento de notificações de status em tempo real via Webhook
• Varredura e gestão de boletos a pagar (DDA), ver DDA, Débito Direto Autorizado

Antes de começar

Antes de fazer sua primeira chamada, você precisa ter:

Ambientes disponíveis:

2.Passo a passo: sua primeira chamada

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=multipag.boleto.pagar'

Para múltiplos escopos, separe por espaç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=multipag.boleto.pagar multipag.boleto.consultar multipag.tributos.pagar multipag.tributos.consultar multipag.pix.pagar multipag.pix.consultar'

3.Escopos disponíveis:

4.Criar um pagamento de boleto

Crie um pagamento de boleto via código de barras em POST /v1/pagamentos/boletos. Os parâmetros vão no corpo da requisição (JSON):

curl --location '<https://mtls-api-parceiro.sicredi.com.br/sb/multipag-pagamento-sandbox/v1/pagamentos/boletos>' \  --header 'Authorization: Bearer SEU_ACCESS_TOKEN' \  --header 'Content-Type: application/json' \  --data '{    "conta": "000001",    "cooperativa": "0100",    "documento": "11111111000111",    "codigoBarra": "74892950500006000001123100010108100200003107",    "dataPagamento": "2026-08-04",    "valorPagamento": 6000,    "identificadorPagamentoAssociado": "BOLETO SICREDI",    "idTransacao": "0910BS125"  }'

5.Parâmetros (body JSON):

• codigoBarra (string, obrigatório): código de barras do boleto, 44 caracteres
• conta (string, obrigatório): conta com DV sem traço do associado cadastrado
• cooperativa (string, obrigatório): cooperativa do associado, 4 dígitos com zeros à esquerda
• dataPagamento (data AAAA-MM-DD, obrigatório): data do pagamento. Data atual = instantâneo; data futura = agendado
• documento (string, obrigatório): CPF/CNPJ do associado (apenas números)
• identificadorPagamentoAssociado (string, obrigatório): identificador fornecido pelo associado, máx. 100 caracteres
• idTransacao (string, obrigatório): ID da transação, máx. 100 caracteres
• valorPagamento (decimal, obrigatório): valor a ser pago, mín. 0, 2 casas decimais
• cpfCnpjBeneficiario (string, opcional): se informado, valida se o documento é igual ao do beneficiário do boleto

6.Resposta esperada (200 OK):

{  "idPagamentoBoleto": "68b3df07-0571-4438-89dc-aca624368dee",  "codigoBarra": "74892950500006000001123100010108100200003107",  "dataPagamento": "2026-08-04",  "valorPagamento": 6000,  "identificadorPagamentoAssociado": "BOLETO SICREDI",  "idTransacao": "0910BS125",  "status": "RECEBIDO"}

7.Consultar o status do pagamento

Consulte um pagamento pelo idTransacao em GET /v1/pagamentos/boletos/{idTransacao}. Os dados do associado vão nos headers:

curl --location '<https://mtls-api-parceiro.sicredi.com.br/sb/multipag-pagamento-sandbox/v1/pagamentos/boletos/0910BS125>' \  --header 'Authorization: Bearer SEU_ACCESS_TOKEN' \  --header 'x-cooperativa: 0100' \  --header 'x-conta: 000001' \  --header 'x-documento: 11111111000111'

8.Parâmetros:

• idTransacao (path, obrigatório): identificador único da transação
• x-cooperativa (header, obrigatório): cooperativa do associado, 4 dígitos
• x-conta (header, obrigatório): conta com DV sem traço
• x-documento (header, obrigatório): CPF/CNPJ do associado (apenas números)

Escopo exigido: multipag.boleto.consultar.

Resposta esperada (200 OK):

{  "idPagamentoBoleto": "68b3df07-0571-4438-89dc-aca624368dee",  "codigoBarra": "74892950500006000001123100010108100200003107",  "dataPagamento": "2026-08-04",  "valorPagamento": 6000,  "identificadorPagamentoAssociado": "BOLETO SICREDI",  "idTransacao": "0910BS125",  "status": "SUCESSO"}

9.Tratamento de erros

10.Endpoints disponíveis

11.Webhook (notificações de status)

Para receber notificações de mudança de status dos pagamentos, configure uma URL pública via PATCH /v1/associado/webhook no ambiente de produção (https://mtls-api-parceiro.sicredi.com.br/multipag-cadastro).

curl --location --request PATCH '<https://mtls-api-parceiro.sicredi.com.br/multipag-cadastro/v1/associado/webhook>' \  --header 'Authorization: Bearer SEU_ACCESS_TOKEN' \  --header 'x-cooperativa: 0100' \  --header 'x-conta: 000001' \  --header 'x-documento: 11111111000111' \  --header 'Content-Type: application/json' \  --data '{    "urlCallback": "<https://sua-api.com.br/webhook>",    "authorizationCallback": "SEU_TOKEN_CALLBACK"  }'

12.Próximos passos

Precisa de ajuda?

• Suporte técnico e integração: E-mail [email protected], contendo "Resumo da solicitação + CNPJ do associado" no assunto
• Atendimento ao associado: 0800 724 7220, WhatsApp (51) 3358 4770