# 00 Overview

Classificação da informação: Uso Interno 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
 
 
Manual API da 
Cobrança 
Cobrança 
Versão 3.9.1 
 
 
 
 
 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 2 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
11/11/2025 – Versão 3.9 
 
Sumário 
1. 
Apresentação ..................................................................................................... 6 
2. 
Para quem? ........................................................................................................ 6 
3. 
Objetivo ............................................................................................................. 6 
4. 
Orientações Iniciais ............................................................................................ 6 
5. 
Quais as funcionalidades? ................................................................................. 7 
6. 
Iniciando a integração ....................................................................................... 9 
7. 
Recursos disponíveis ........................................................................................ 12 
7.1. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 16 
URL Produção: .................................................................................................................................................. 16 
Execução (via ferramenta Postman) .............................................................................................................. 17 
7.2. 
URL Sandbox (Ambiente para homologação): ....................................................................................................... 44 
URL Produção: .................................................................................................................................................. 45 
Execução (via ferramenta Postman) .............................................................................................................. 49 
7.3. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 53 
URL Produção: .................................................................................................................................................. 53 
Execução (via ferramenta Postman) .............................................................................................................. 54 
7.4. 
URL Sandbox (ambiente de homologação): .......................................................................................................... 59 
URL Produção: .................................................................................................................................................. 59 
Execução (via ferramenta Postman) .............................................................................................................. 60 
7.5. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 67 
URL Produção: .................................................................................................................................................. 67 
Execução (via ferramenta Postman) .............................................................................................................. 68 
7.6. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 75 
URL Produção: .................................................................................................................................................. 75 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 3 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) .............................................................................................................. 76 
7.7. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 84 
URL Produção: .................................................................................................................................................. 84 
Execução (via ferramenta Postman) .............................................................................................................. 85 
7.8. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 92 
URL Produção: .................................................................................................................................................. 92 
Execução (via ferramenta Postman) .............................................................................................................. 93 
7.9. 
URL Sandbox (ambiente para homologação): ....................................................................................................... 99 
URL Produção: ................................................................................................................................................ 100 
Execução (via ferramenta Postman) ............................................................................................................ 100 
7.10. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 107 
URL Produção: ................................................................................................................................................ 107 
Execução (via ferramenta Postman) ............................................................................................................ 108 
7.11. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 113 
URL Produção: ................................................................................................................................................ 113 
Execução (via ferramenta Postman) ............................................................................................................ 114 
7.12. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 119 
URL Produção: ................................................................................................................................................ 119 
Execução (via ferramenta Postman) ............................................................................................................ 120 
7.13. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 124 
URL Produção: ................................................................................................................................................ 125 
Execução (via ferramenta Postman) ............................................................................................................ 125 
7.14. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 130 
URL Produção: ................................................................................................................................................ 131 
Execução (via ferramenta Postman) ............................................................................................................ 131 
7.15. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 136 
URL Produção: ................................................................................................................................................ 136 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 4 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) ............................................................................................................ 137 
7.16. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 141 
URL Produção: ................................................................................................................................................ 142 
Execução (via ferramenta Postman) ............................................................................................................ 142 
7.17. 
URL Sandbox (ambiente de homologação): ........................................................................................................ 147 
URL Produção: ................................................................................................................................................ 148 
Execução (via ferramenta Postman) ............................................................................................................ 148 
7.18. 
URL Sandbox (ambiente para homologação): ..................................................................................................... 158 
URL Produção: ................................................................................................................................................ 158 
Execução (via ferramenta Postman) ............................................................................................................ 161 
7.19. 
URL Sandbox (ambiente para homologação): ..................................................................................................... 168 
URL Produção: ................................................................................................................................................ 168 
Execução (via ferramenta Postman) ............................................................................................................ 169 
7.20. 
URL Produção: ................................................................................................................................................ 176 
Execução (via ferramenta Postman) ................................................................................................................... 176 
7.21. 
URL Sandbox (ambiente para homologação): ..................................................................................................... 183 
URL Produção: ................................................................................................................................................ 183 
Execução (via ferramenta Postman) ................................................................................................................... 184 
7.22. 
URL Sandbox (ambiente para homologação): ..................................................................................................... 197 
URL Produção: ................................................................................................................................................ 197 
Execução (via ferramenta Postman) ............................................................................................................ 200 
7.23. 
Cancelar Parcelas de Distribuição de Crédito de um Boleto ......................... 202 
URL Sandbox (ambiente para homologação): ..................................................................................................... 205 
URL Produção: ................................................................................................................................................ 205 
Execução (via ferramenta Postman) ............................................................................................................ 206 
7.24. 
Liberar Repasse de Distribuição de Crédito de um Boleto ............................ 209 
URL Sandbox (ambiente para homologação): ..................................................................................................... 211 
URL Produção: ................................................................................................................................................ 212 
Execução (via ferramenta Postman) ............................................................................................................ 212 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 5 
 
 
 
 
Classificação da informação: Uso Irrestrito 
8. 
Geração Nosso Número................................................................................. 215 
9. 
Layout do Boleto............................................................................................ 217 
10. 
11. 
11.1. 
API associado para Recebimentos de eventos Webhook ........................................... 222 
12. 
Apresentação API Recebimento de eventos ................................................. 222 
13. 
Objetivo ......................................................................................................... 222 
14. 
Orientações Iniciais ........................................................................................ 223 
15. 
Quais as funcionalidades? ............................................................................. 223 
16. 
Parâmetros API de Recebimentos de eventos .............................................. 224 
API de Contratação Webhook ..................................................................................... 228 
17. 
Apresentação API de Contratação Webhook ................................................ 228 
18. 
Para quem? .................................................................................................... 228 
19. 
Objetivo ......................................................................................................... 229 
20. 
Orientações Iniciais ........................................................................................ 229 
21. 
Quais as funcionalidades? ............................................................................. 229 
22. 
Iniciando a integração ................................................................................... 230 
23. 
Recursos disponíveis ...................................................................................... 233 
23.1. 
URL Produção: ................................................................................................................................................ 237 
Execução (via ferramenta Postman) ............................................................................................................ 238 
23.2. 
Realizar Contratação Webhook ..................................................................... 242 
URL Produção: ................................................................................................................................................ 247 
Execução (via ferramenta Postman) ............................................................................................................ 248 
23.3. 
URL Produção: ................................................................................................................................................ 252 
Execução (via ferramenta Postman) ............................................................................................................ 253 
23.4. 
Altera Contrato Webhook ............................................................................. 255 
URL Produção: ................................................................................................................................................ 261 
Execução (via ferramenta Postman) ............................................................................................................ 262 
24. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 6 
 
 
 
 
Classificação da informação: Uso Irrestrito 
1. Apresentação 
 
gestão, seu site ou seu app. O uso da API de Cobrança traz benefícios como: boletos imediatamente 
disponíveis para liquidação do pagador, situação da carteira de boletos em tempo real. A API de Cobrança 
está disponível 24 horas, 7 dias por semana.  
2. Para quem? 
 
       São variados os tipos de negócios que podem empregar este tipo de recebimento. Negócios 
representados por uma Pessoa Jurídica, seja do ramo da indústria, comércio, prestação de serviço, 
agronegócio, Governo*, não importando esferas municipais, estaduais ou federal, da administração 
direta ou indireta, ou Pessoa Física, profissional liberal, produtor rural ou autônomo, que precisem 
receber recursos oriundos de uma oferta, proposta, venda ou serviço prestado. 
3. Objetivo 
 
       Este manual destina-se às pessoas responsáveis pelo desenvolvimento e adaptação dos sistemas 
das empresas associadas ao Sicredi e que desejam trabalhar coma Cobrança através da integração via 
API.  
4. Orientações Iniciais 
Para iniciar o processo de integração da API da Cobrança, o associado deve contratar o produto 
Cobrança com a pessoa Gerente de conta e optar pela modalidade API (Cobrança Online). 
 
obrigatório na integração e na troca de informações entre a empresa ou pessoa associada e o Sicredi.  
 
Logo, para promover a integração sistêmica de registro on-line de Boletos a empresa ou pessoa associada 
inicialmente precisa:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 7 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Ter contratado o produto Cobrança através da sua cooperativa; 
Ter optado pela modalidade API (Cobrança Online); 
Ter o termo de contratação/adesão assinado; 
5. Quais as funcionalidades? 
A API da Cobrança contém as seguintes funcionalidades: 
 
cobrança:  
 
informativo e das mensagens relacionadas ao boleto a ser criado. Essa opção trata-
 
dados constantes no boleto tradicional além do QR Code dinâmico vinculado a esse 
boleto. Dessa forma o pagador pode escolher por qual meio realizar o pagamento, 
híbridos é necessário ter optado por essa modalidade na contratação do 
produto junto à cooperativa/agência. Caso a empresa associada não tenha 
optado, ela pode a qualquer momento solicitar a habilitação à pessoa gerente de 
conta.  
 
Importante: Quando o usuário informar a data de carência para juros e a data de 
carência para multa, e o beneficiário estiver cadastrado na modalidade híbrida, o 
se deve ao fato de que, atualmente, o QR Code não contempla campos específicos 
para indicar as datas de carência de juros e multa. 
 
o Boleto com Distribuição de Crédito (Rateio): É uma opção, tanto para boleto 
tradicional, quanto para híbrido, onde o associado poderá informar para quais 
contas deseja realizar o repasse do crédito do boleto (também chamado no 
mercado como Split por Pagamento). Nessa opção será possível escolher entre 
repasse para contas de outras IFs - via TED (Transferência Eletrônica Disponível) 
e/ou repasse para contas Sicredi de qualquer agência.   
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 8 
 
 
 
 
Classificação da informação: Uso Irrestrito 
boletos já emitidos, tradicionais ou híbridos. 
 
boleto. 
 
da data de vencimento do boleto. 
 
valor de desconto do boleto.  
 
 
valor/percentual de juros do boleto. 
 
do seu número do boleto. 
 
a um título. 
 
concessão de abatimento a um título. 
 
protesto de um título vencido. 
 
sustar o protesto de um título e manter o título em carteira. 
 
 
de um boleto vencido. 
 
 
protesto automático de um título que possui essa informação. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 9 
 
 
 
 
Classificação da informação: Uso Irrestrito 
boleto, através do Nosso Número. 
 
de uma data específica. 
 
movimentações financeiras (Crédito, Débito e Ambas) de uma data específica. 
 
determinado boleto, através do Nosso Número, que possua dados de Distribuição de Crédito. 
 
Cancelar Parcelas de um Boleto com Distribuição de Crédito: Operação responsável por realizar o 
cancelamento de parcelas de um determinado boleto (ou seja, quantidade de rateios cadastrados 
para o boleto) que possuam Distribuição de Crédito. 
 
Liberar Repasse de um Boleto com Distribuição de Crédito: Operação responsável por realizar a 
liberação do repasse de créditos de um boleto que possua Distribuição de Crédito. Essa ação 
Automático Split” preenchido com “Não”.  
 
Webhook: A API de Recebimento de eventos Webhook é uma API que deve ser desenvolvida pelo 
associado com o objetivo de se comunicar e realizar uma integração com a API Webhook do Sicredi, 
a fim de receber os eventos sobre as movimentações que ocorrem em seus títulos de cobrança. 
6. Iniciando a integração 
Para iniciar a integração há um processo constituído de etapas sequenciais para Validação e 
Produção:  
 
1. Validação/Teste 
 
Acessar o Portal do Desenvolvedor: 
a. Criação de APP para Homologação 
c. Testes nas URLS  
 
a. Criação de APP para Homologação: para criar a APP de homologação, o desenvolvedor 
deve acessar o Portal do Desenvolvedor Sicredi (clique aqui) e criar uma conta ou logar. Após 
criar uma conta ou logar, o desenvolvedor deve clicar em ‘criar uma nova aplicação’. Ao criar 
SandBox’ para identificar que é a APP de homologação e selecionar a API da Cobrança [ API 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 10 
 
 
 
 
Classificação da informação: Uso Irrestrito 
automaticamente para essa APP.  
 
 
 
 
 
 
 
 
você deve, ainda no portal do desenvolvedor, clicar no menu suporte > abrir chamado. 
Selecione a opção “COLOCAR AQUI QUAL OPÇÃO”, e preencha o nome da APP com aquele 
selecionando a app criada e clicando em ‘ver detalhes’. 
 
 
 
 
 
c. Testes nas URLS: No decorrer desse manual você encontrará as URLs para teste dos 
recursos disponíveis em ambiente de homologação. 
 
2. Produção  
 
Acessar o Portal do Desenvolvedor 
a. Criação de APP para Produção 
 
Acessar o Internet Banking 
1.Criando a APP no portal  
2. Selecionando as APIs na lista 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 11 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
a. Criação de APP para produção: Para criar a APP de produção, você pode repetir os 
mesmos passos da criação da APP de homologação, no entanto, lembre-se de nomear 
essa nova APP de uma forma que você identifique que ela se trada da APP de produção, 
APP você terá acesso imediato ao Client ID de produção. 
 
disponibilizado no mesmo prazo anteriormente citado e poderá ser visualizado no menu 
minhas apps.  
 
 
 
 
 
 
 
É importante lembrar que em todas as operações será necessário informar no cabeçalho 
diferente para o ambiente de Homologação (Sandbox) e Produção, deve ser informado o 
 
c. 
Internet Banking, pela conta vinculada ao seu convênio de Cobrança, e selecionar a opção 
exclusivamente para os beneficiários que possuem a modalidade API(Cobrança Online) 
habilitada no convênio.  
 
4. Visualizando as APPs no menu 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 12 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
5. 
Se você ou a sua empresa associada não possui a modalidade habilitada e 
deseja habilitá-la, converse com a pessoa gerente de conta. 
 
A chave será gerada após informado o dispositivo de segurança. Ela deve ser armazenada e utilizada 
para permitir as operações. Caso o beneficiário possua mais de uma conta com o produto Cobrança 
 
 
 
 
7. Recursos disponíveis 
 
 
Em todas as operações será necessário informar no cabeçalho da requisição no campo x-api-key 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 13 
 
 
 
 
Classificação da informação: Uso Irrestrito 
padrão JWT. 
O formato de entrada é “x-www-form-urlencoded” e saída é JSON, considerando que a saída 
codificação utilizado no Response é Unicode UTF-8. 
Observação: deve ser respeitada a orientação da segurança da informação referente a expiração 
“refresh_expires_in” (exemplo: 900 segundos) de retorno do serviço respectivamente. Os parâmetros de 
expiração (“expires_in” e “refresh_expires_in”) podem ser diferentes em Teste e Produção. 
“username” e “password”. 
usuário e senha (username e password).  
 
 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetro 
Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key String  
HeaderParam  
36 
UUID 
38 bits 
gerado no 
portal do 
desenvolvedor 
Obrigatório  
2 
context 
String 
HeaderParam 8 
COBRANCA 
Contexto, 
passar fixo 
“COBRANCA”  
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 14 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
Content-
Type 
 
HeaderParam   
 application/x-
www-form-
urlencoded 
Indica o tipo 
de arquivo do 
recurso  
Obrigatório  
4 
grant_typ
e 
String 
Body 
Até 13 
password ou 
Tipo de 
pág 113 
Obrigatório 
5 
username String 
Body 
9 
Sem 
formatação 
beneficiário + 
Cooperativa 
Obrigatório para 
Grant Type  
igual a 
password 
6 
password String 
Body 
64 
Sem 
formatação 
Acesso gerado 
no Internet 
Banking 
Obrigatório para 
Grant Type igual 
password 
7 
refresh_t
oken 
String 
Body 
753 
Sem 
formatação 
dígitos 
obtido 
anteriormente 
na 
Obrigatório para 
Grant Type igual 
8 
scope 
String 
Body 
8 
cobranca 
Escopo de 
acesso. Passar 
fixo 
“cobranca”. 
Obrigatório para 
Grant Type 
password 
 
 
SAÍDA: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetro 
Formatação 
Descrição 
1  
String  
JSON  
576 bits  
utilizado 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 15 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
RETORNO (Response): 
 
 
 
 
 
FALHAS: 
2  
String  
JSON  
2017-08-
09T08:53:11.679-
03:00 
3 
String 
JSON 
636 dígitos 
Será utilizado para gerar um 
necessidade de uma nova 
senha 
4 
expires_in 
String 
JSON 
3 dígitos 
Tempo de expiração (em 
5 
refresh_expires_in String 
JSON 
6 dígitos 
Tempo de expiração (em 
6 
scope 
String 
JSON 
cobranca profile 
email 
Escopo que o usuário possui 
acesso. 
Descrição 
HTTP_OK (200)  
Operação realizada com sucesso  
Mensagem 
Parâmetros de 
entrada 
sujeitos a crítica 
Descrição 
HTTP_NOT_FOUND (404)  
ao realizar 
operação de 
Não possui  
(URL) inválido. Deve-se 
verificar a url utilizada. 
HTTP_UNAUTHORIZED (401)  
Invalid user 
credentials  
username, 
password, 
context 
username ou password não 
informado ou  
inválidos. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 16 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
REQUEST – POST:  
URL Sandbox (ambiente para homologação):  
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “username” e 
“password”: 
username : 123456789 
password: teste123 
URL Produção:  
RESPONSE: 
{ 
"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJxMlRFLXliYWxnNjIxSmRCMU9IX0w2Sms5QllxODJtNkFS
Z0NGaDZtQnZBIn0.eyJleHAiOjE2NTY0NTA5MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiZjNiYjg5YzQtOGRmM
y00OTMxLWExOTItMjUxMjUxZWE1YzNkIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGk
uY2xvdWQvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjozMWY3ODE1MS1jMzdmLTQzO
WYtYTIwOS02NjFjYTQ3MzkzYTE6Q09CUkFOQ0E6MDA0MTQwMTE2IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoib3Bl
bmFwaS1ndy1zZW5zZWRpYSIsInNlc3Npb25fc3RhdGUiOiIwNGQ3YTAwYS05MjhiLTQ3NzQtYTY1MC1mOWQx
ODkzNWE3NDMiLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbImRlZmF1bHQtcm9sZXMtb3BlbmFwa
SIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW
50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbG
HTTP_UNAUTHORIZED  
(401) 
Missing 
parameter: 
username 
username 
username não informado. 
HTTP_UNAUTHORIZED  
(401) 
Could not find a 
required Access 
request, 
identified by 
HEADER x-api-key 
x-api-key 
parâmetro x-api-key não foi 
informado ou está inválido. 
HTTP_BAD_REQUEST (400) 
Missing form 
parameter: 
grant_type 
grant_type 
parâmetro grant_type não é 
informado ou  
inválido. 
HTTP_GATEWAY_TIMEOUT 
(504) 
Gateway Timeout Não se aplica 
serviço não conseguiu 
responder no tempo 
esperado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 17 
 
 
 
 
Classificação da informação: Uso Irrestrito 
UiXX19LCJzY29wZSI6ImNvYnJhbmNhIHByb2ZpbGUgZW1haWwiLCJzaWQiOiIwNGQ3YTAwYS05MjhiLTQ3NzQ
tYTY1MC1mOWQxODkzNWE3NDMiLCJvcGVuYXBpX3VzZXJuYW1lIjoiMDA0MTQwMTE2Iiwib3BlbmFwaV9jb2
50ZXh0IjoiQ09CUkFOQ0EiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6IjAwNDE0M
DExNiJ9.mVzfyzBhVFwRWVnQkbiD00zitoOfmatRcDN_e_OKo4XKcOY6RU-qlpJ0FOC-
_7Qy5ez7XveNeRyq47ToY6F0skbw-0BswxY3qdQHBr50G-
AxqICYLSUTEamrPc0vLNwADdPracL9P2W_EVEFLae7QeVzc0toNLjvaLJCaGZH6-
wV99qMjf0VUj5nRCUm6ZCllb3NioyI6mXsj0Ea1s8RdgnanWvgvD-
cNjmCmMXVhy7U_MScLIb_7cIrn4TbcbkA3r11b96KzU9cp5BCXHZysDdX0wRFVzQUQfBsf33E40GSNJ-
juFZdV86vWCmx7BjKnC1s3embfX0p-9JnbNUy7Q", 
    "expires_in": 300, 
    "refresh_expires_in": 1800, 
"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJhMTRlOTdmOC1lZmJiLTQ2YTYtOTYwYy0wNTFlZjA4MT
U3MjEifQ.eyJleHAiOjE2NTY0NTI0MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiOWIyOWE3YjMtYzRhNS00NGQz
LTg3MjQtZWU4ZGQzYjIwNDAxIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGkuY2xvdW
QvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJodHRwczovL2F1dGgtb3BlbmFwaS5wcmQuc2ljcmVkaS5jbG91ZC9y
ZWFsbXMvb3BlbmFwaSIsInN1YiI6ImY6MzFmNzgxNTEtYzM3Zi00MzlmLWEyMDktNjYxY2E0NzM5M2ExOkNP
QlJBTkNBOjAwNDE0MDExNiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJvcGVuYXBpLWd3LXNlbnNlZGlhIiwic2Vzc2lvbl9z
dGF0ZSI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyIsInNjb3BlIjoiY29icmFuY2EgcHJvZ
mlsZSBlbWFpbCIsInNpZCI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyJ9.Om0gACw3fK
yfSnWyNhlElQSMYYtClCHrZYdGAIc4ul0", 
    "not-before-policy": 0, 
    "session_state": "04d7a00a-928b-4774-a650-f9d18935a743", 
    "scope": "cobranca profile email" 
} 
 
Execução (via ferramenta Postman) 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 18 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 19 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 20 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 21 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
A operação POST “criar” é responsável pela geração de boletos individuais de Cobrança 
(Tradicional, Híbrido ou com Distribuição de Crédito por Boleto). O formato de entrada e saída é JSON, 
um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão o recurso 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Parametro Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key 
String 
Header 
Param 
38 
UUID 
gerado no portal 
do desenvolvedor 
Obrigatório 
1 
Authorization 
String  
Header 
Param  
1413 
Campo 
obtido na 
saída da 
Obrigatório  
2 
Content-Type 
Applicatio
n/json 
Header 
param 
 
Sem formatação 
Estabelece o 
tipo de 
conteúdo da 
requisição 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 22 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
cooperativa 
String 
Header 
Param 
4 
Sem formatação 
Cooperativa - 
Obrigatório 
4 
posto 
String  
Header 
Param  
2  
Sem formatação  
Agência  
Obrigatório  
5 
tipoCobranca 
String 
Body 
7 
Domínios: NORMAL 
ou HIBRIDO 
Indica o tipo de 
cobrança do 
boleto, podendo 
ser: NORMAL 
(Tradicional, sem 
QRCode) ou 
Híbrido  
Obrigatório 
6  
codigoBeneficia
rio 
String  
Body  
5  
Sem formatação  
Convênio de  
Cobrança  
Obrigatório  
7 
pagador 
Objeto 
Body 
 
 
Informações do 
Pagador 
Obrigatório 
8 
tipoPessoa 
String  
Body  
15  
Domínios: 
PESSOA_JURIDICA 
ou PESSOA_FISICA  
Tipo de pessoa 
do Pagador  
Obrigatório  
9 
documento 
String 
Body 
14 
Sem formatação 
CPF ou CNPJ do 
Pagador do 
boleto 
Obrigatório 
10 nome 
String 
Body 
200 
Sem formatação 
Nome do 
Pagador  
(Caso o nome 
ultrapasse 40 
caracteres, 
haverá uma 
abreviação a 
partir do 
caractere 40.) 
Obrigatório 
11 endereco 
String 
Body 
40 
Sem formatação 
Endereço do 
Pagador 
Opcional 
(obrigatório se o 
beneficiário está 
configurado 
para validar 
cep) 
12 cidade 
String 
Body 
40 
Sem formatação 
Cidade do 
Pagador 
Opcional 
(obrigatório se o 
beneficiário está 
configurado 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 23 
 
 
 
 
Classificação da informação: Uso Irrestrito 
para validar 
cep) 
13 uf 
String 
Body 
2 
Sem formatação 
UF do Pagador 
Opcional 
(obrigatório se o 
beneficiário está 
configurado 
para validar 
cep) 
14 cep 
String 
Body 
8 
0-9 
CEP do Pagador 
Opcional 
(obrigatório se o 
beneficiário está 
configurado 
para validar 
cep) 
15 telefone 
String 
Body 
11 
0-9 
Telefone do 
Pagador 
Opcional 
16 email 
String 
Body 
40 
xxx@xx.xx 
Email do 
Pagador 
Opcional 
17 beneficiarioFinal Objeto 
Body 
 
 
Informações do 
Beneficiário Final 
(Avalista) 
Opcional  
18 documento 
String 
Body 
14 
Sem Formatação 
CPF/CNPJ do 
Beneficiário Final 
Obrigatório 
19 tipoPessoa 
String 
Body 
15 
Domínios: 
PESSOA_JURIDICA 
ou PESSOA_FISICA 
Tipo de Pessoa 
Obrigatório 
20 nome 
String 
Body 
40 
Sem formatação 
Nome do 
Beneficiário Final 
Obrigatório 
21 logradouro 
String 
Body 
40 
Sem formatação 
Logradouro do 
Beneficiário Final 
Opcional 
23 numeroEnderec
o 
String 
Body 
20 
Sem formatação 
Número do 
endereço do 
Beneficiário Final 
Opcional 
24 cidade 
String 
Body 
25 
Sem formatação 
Cidade do 
Beneficiário Final 
Opcional 
25 uf 
String 
Body 
2 
Sem formatação 
UF do 
Beneficiário Final 
Opcional 
26 cep 
String 
Body 
8 
0-9 
CEP do 
Beneficiário Final 
Opcional 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 24 
 
 
 
 
Classificação da informação: Uso Irrestrito 
27 telefone 
String 
Body 
11 
0-9 
Telefone do 
Beneficiário Final 
Opcional 
28 email 
String 
Body 
40 
xxx@xx.xx 
Email do 
Beneficiário Final 
Opcional 
29 especieDocume
nto  
String  
Body  
29 
Domínios: 
  
DUPLICATA_MERCAN
TIL_INDICACAO 
 
DUPLICATA_RURAL 
 
NOTA_PROMISSORIA 
 
NOTA_PROMISSORIA
_RURAL 
 
NOTA_SEGUROS 
 
RECIBO 
 
LETRA_CAMBIO 
 
NOTA_DEBITO 
 
DUPLICATA_SERVICO
_INDICACAO 
 
OUTROS 
 
BOLETO_PROPOSTA 
 
CARTAO_CREDITO 
 
BOLETO_DEPOSITO 
Espécie de 
documento do 
título, podendo 
ser:  
 
A - DUPLICATA 
MERCANTIL 
INDICAÇÃO 
 
B - DUPLICATA 
RURAL 
 
C - NOTA 
PROMISSO
RIA 
 
D - NOTA 
PROMISSO
RIA RURAL 
 
E - NOTA 
DE 
SEGUROS 
 
G – RECIBO 
 
H - LETRA 
DE CAMBIO 
 
I - NOTA DE 
DÉBITO 
 
J - DUPLICATA DE 
SERVICO 
INDICAÇÃO 
 
K – OUTROS 
 
O - BOLETO 
PROPOSTA 
 
P - CARTÃO DE 
CRÉDITO 
 
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 25 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Q – BOLETO 
DEPÓSITO 
30 nossoNumero 
String 
Body 
9 
Sem formatação 
Nosso número 
Opcional. Caso 
o beneficiário 
não informe, o 
Sicredi gera 
automaticamen
te. 
31 seuNumero  
String  
Body  
10  
Sem formatação  
Número de 
controle interno 
do beneficiário 
que faz referência 
ao pagador.  
Obrigatório  
32 idTituloEmpresa 
String 
Body 
25 
Sem formatação 
Id de controle do 
beneficiário. 
Semelhante ao 
“seuNumero” 
que permite mais 
caracteres. 
Opcional 
32  dataVencimento  Date  
Body  
10  
YYYY-MM-DD  
Data de 
vencimento do 
boleto  
Obrigatório  
33 diasProtestoAut
o 
Integer 
Body 
2 
Sem formatação 
Quantidade de 
dias, após o 
vencimento, em 
que será 
realizado o 
protesto 
automático do 
boleto 
Opcional. Não 
poderá ser 
informado, caso 
o campo 
“diasNegativaca
oAuto” esteja 
preenchido 
34 diasNegativacao
Auto 
Integer 
Body 
2 
Sem formatação 
Quantidade de 
dias, após o 
vencimento, em 
que o boleto será 
Opcional. Não 
poderá ser 
informado, caso 
o campo 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 26 
 
 
 
 
Classificação da informação: Uso Irrestrito 
negativado 
automaticamente
. 
“diasProtestoAu
to” esteja 
preenchido 
35 validadeAposVe
ncimento 
Integer 
Body 
4 
Sem formatação 
Quantidade de 
dias que o QR 
Code continuará 
válido após o 
vencimento, caso 
seja um boleto 
híbrido. 
Opcional. Caso 
não informado, 
será preenchido 
com o valor 
contido no 
campo de 
quantidade de 
automática 
existente no 
beneficiário 
36  valor  
number 
Body  
14,2  
Sem formatação  
Valor do boleto  
Obrigatório. 
(Caso seja tipo 
de boleto 
NORMAL 
(Tradicional) e 
espécie Boleto 
Proposta pode 
ser informado 
0,00) 
 
37  tipoDesconto  
String  
Body  
10 
Domínios: VALOR 
ou PERCENTUAL 
Tipo de 
desconto 
podendo ser:  
A - VALOR  
B - PERCENTUAL  
Opcional 
38  valorDesconto1  
number 
Body  
14,2  
Sem formatação  
Valor de 
desconto 1  
Opcional. Será 
obrigatório se o 
campo 
dataDesconto1 
for informado. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 27 
 
 
 
 
Classificação da informação: Uso Irrestrito 
39  dataDesconto1  
Date  
Body  
10  
YYYY-MM-DD 
Data limite para 
concessão de 
desconto1  
Opcional. Será 
obrigatório se o 
campo 
valorDesconto1 
for informado. 
Não pode ser 
igual as outras 
datas de 
desconto e nem 
maior que 
vencimento. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 
40 valorDesconto2  
number 
Body  
14,2  
Sem formatação  
Valor de 
desconto 2  
Opcional. Será 
obrigatório se o 
campo 
dataDesconto2 
for informado. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 
41 dataDesconto2  
Date  
Body  
10  
YYYY-MM-DD 
Data limite para a 
concessão de 
desconto 2  
Opcional. Será 
obrigatório se o 
campo 
valorDesconto2 
for informado. 
Não pode ser 
igual as outras 
datas de 
desconto e nem 
maior que 
vencimento. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 28 
 
 
 
 
Classificação da informação: Uso Irrestrito 
42 valorDesconto3  
number 
Body  
14,2  
Sem formatação  
Valor de 
desconto 3  
Opcional. Será 
obrigatório se o 
campo 
dataDesconto3 
for informado. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 
43 dataDesconto3  
Date  
Body  
10  
YYYY-MM-DD 
Data limite para a 
concessão de 
desconto 3  
Opcional. Será 
obrigatório se o 
campo 
valorDesconto3 
for informado. 
Não pode ser 
igual as outras 
datas de 
desconto e nem 
maior que 
vencimento. 
Não deverá ser 
informado caso 
o desconto 
antecipado 
esteja 
preenchido 
44 descontoAnteci
pado 
number 
Body 
14,2 
Sem formatação 
Valor de 
Desconto 
Antecipado 
Opcional. Não 
deverá ser 
informado caso 
o desconto 
normal esteja 
preenchido 
45 tipoJuros  
String  
Body  
10 
Domínios: VALOR 
ou PERCENTUAL  
Tipo de 
Juros, 
podendo ser: 
A - VALOR  
B - PERCENTUAL  
Opcional 
46 tipoJurosPercen
tual 
String 
Body 
6 
Domínios: DIARIO 
ou MENSAL 
Tipo de Juros 
Percentual: 
A - DIARIO 
B - MENSAL 
Opcional 
47  juros  
number 
Body  
14,2  
Sem formatação  
Valor de juros a 
cobrar por dia  
Opcional  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 29 
 
 
 
 
Classificação da informação: Uso Irrestrito 
48 dataInicioJuros 
number 
Body 
10 
YYYY-MM-DD 
Data de início 
para cobrança 
dos Juros 
Opcional, se 
informada o 
boleto sempre 
será tradicional 
(sem QR Code) 
47 tipoMulta 
String 
Body 
10 
Domínios: VALOR 
ou PERCENTUAL 
Tipo de multa 
Opcional 
48 multa  
number 
Body  
5,2  
Sem formatação  
Percentual ou 
valor de multa a 
cobrar  
Opcional  
49 dataInicioMulta 
number 
Body 
10 
YYYY-MM-DD 
Data de início 
para cobrança da 
Multa 
Opcional, se 
informada o 
boleto sempre 
será tradicional 
(sem QR Code) 
50 informativo  
List<Strin
g> 
Body  
400  
Sem formatação  
Permitido 
informar uma 
lista de até 5 
informativos, com 
limite de 80 
caracteres para 
cada. 
Opcional  
51 mensagem  
List<Strin
g> 
Body  
320 
Sem formatação  
Permitido 
informar uma 
lista de até 4 
mensagens, com 
limite de 80 
caracteres para 
cada 
Opcional  
52 splitBoleto 
List<Strin
g> 
Body 
 
 
Informações da 
distribuição de 
crédito por 
boleto. 
Opcional. Será 
obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
53 regraRateio 
String 
Body 
14 
Domínios: 
- MENOR_VALOR 
- VALOR_COBRADO 
- VALOR_REGISTRO 
Regra do rateio 
que será utilizada 
no Split - 
distribuição do 
crédito. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito 
54 repasseAutomat
icoSplit 
String 
Body 
3 
Domínios: 
- SIM 
- NAO 
Repasse 
automático do 
Split - distribuição 
do crédito. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 30 
 
 
 
 
Classificação da informação: Uso Irrestrito 
55 tipoValorRateio 
String 
Body 
10 
Domínios: 
- PERCENTUAL 
- VALOR 
Tipo de valor do 
rateio do Split. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
56 destinatarios 
List<order
edMap> 
Body 
 
 
Contas 
destinatárias do 
Split do boleto. 
Poderá ser 
informado de 1 a 
30 contas. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
57 codigoAgencia 
String 
Body 
4 
Sem formatação 
agência com 4 
dígitos 
numéricos. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito 
58 codigoBanco 
String 
Body 
3 
Sem formatação 
com 3 dígitos 
numéricos. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
59 floatSplit 
Integer 
Body 
2 
Sem formatação 
Float Split. 
Poderá ser 
informado de 0 a 
30. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
60 nomeDestinatar
io 
String 
Body 
40 
Sem formatação 
Nome do 
destinatário. 
Poderá ser 
informado de 3 a 
40 caracteres. 
Não poderá 
informar 
caracteres 
especiais. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
61 numeroContaCo
rrente 
String 
Body 
13 
Sem formatação 
Número da conta 
corrente. Poderá 
ser informado de 
4 a 13 caracteres 
numéricos. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
62 numeroCpfCnpj 
String 
Body 
14 
Sem formatação 
Documento do 
destinatário. 
Poderá ser 
informado até 14 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 31 
 
 
 
 
Classificação da informação: Uso Irrestrito 
caracteres 
numéricos. 
63 parcelaRateio 
Integer 
Body 
2 
Sem formatação 
Número da 
parcela do rateio. 
Poderá ser 
informado de 1 a 
30 parcelas. A 
ser em ordem 
crescente. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
64 valorPercentual
Rateio 
Number 
Body 
14,2 
Sem formatação 
Valor/percentual 
do rateio. Poderá 
ser informado até 
16 dígitos, sendo 
dois deles para a 
casa decimal. 
Obrigatório caso 
seja um boleto 
com 
Distribuição de 
Crédito. 
 
SAÍDA: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação 
Descrição 
1  
txid 
String 
32 
Sem formatação  Identificador da transação Pix (quando for tipo de boleto 
híbrido) 
2 
qrCode 
String 
Até 365 
Sem formatação QR CODE utilizado para leitura na opção de Boleto Híbrido 
3 
linhaDigitável String 
47 
Sem formatação Linha Digitável 
4 
codigoBarras  String  
44 
5 
cooperativa  
String  
4 
6 
posto  
String  
2 
7 
nossoNumero  String  
9 
Sem formatação  Nosso Número 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (201)  
Operação aceita com sucesso 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 32 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
FALHAS: 
Mensagem 
Parâmetros 
sujeitos à 
crítica 
Descrição 
HTTP_NOT_FOUND (404)  
Ocorreu um 
realizar 
operação de 
Não possui  
HTTP_UNSUPPORTED_MEDIA
_TYPE (415) 
Tipo de 
conteúdo não 
suportado 
Parâmetro: 
Content-Type 
informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
Unauthorized 
Parâmetro: 
Authorization 
informado ou inválido. 
HTTP_UNAUTHORIZED 
(401) 
 
Cooperativa 
diferente da 
cooperativa do 
usuário 
 
Parâmetro: 
cooperativa 
 
 
HTTP_UNAUTHORIZED 
(401) 
 
beneficiário 
diferente do 
beneficiário do 
usuário 
 
Parâmetro: 
codigoBenefici
ario 
 
 
HTTP_BAD_REQUEST (400)  
Campo 
obrigatório em 
branco  
Qualquer 
parâmetro que 
consta como 
obrigatório na 
listagem de 
parâmetros de 
entrada pode 
ser criticado  
informados ou  
inválidos.  
HTTP_BAD_REQUEST (400)  
O campo 
cooperativa 
deve ser 
preenchido 
com 4 (quatro) 
caracteres 
numéricos. 
Parâmetro: 
cooperativa 
preenchidos ou inválidos. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 33 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
O campo 
posto deve ser 
preenchido 
com 2 (dois) 
caracteres. 
Parâmetro: 
 posto 
preenchidos ou inválidos 
HTTP_BAD_REQUEST (400) 
 
O campo tipo 
cobrança deve 
ser HíBRIDO 
ou NORMAL 
Parâmetro: 
tipoCobranca 
informado ou inválido. 
HTTP_BAD_REQUEST (400) 
 
O campo 
beneficiario 
deve ter 5 
(cinco) 
caracteres 
numéricos. 
Parâmetro: 
codigoBenefici
ario 
informado ou inválido. 
HTTP_BAD_REQUEST (400) 
 
A data de 
vencimento do 
boleto é 
obrigatória e 
deve ser 
preenchida. 
 
 Parâmetro: 
dataVencimen
to 
 
preenchido ou inválido. 
 
HTTP_BAD_REQUEST (400) 
 
Os dias de 
protesto 
automático do 
boleto deve 
ter entre 3 e 
99 dias. 
Parâmetro: 
diasProtestoA
uto 
O campo "diasProtestoAuto" não foi preenchido com 
valores entre 3 e 99. 
HTTP_BAD_REQUEST (400) 
 
O valor de 
juros do 
boleto deve 
ser superior a 
zero, ou não 
informado. 
Parâmetro: 
juros 
O campo "juros" foi preenchido com um valor igual 
ou menor que zero. 
 
HTTP_BAD_REQUEST (400) 
 
O valor de 
multa do 
boleto deve 
ser superior a 
zero, ou não 
informado. 
Parâmetro: 
multa 
O campo "multa" foi preenchido com um valor igual 
ou menor que zero. 
 
HTTP_BAD_REQUEST (400) 
 
O valor do 
primeiro 
desconto do 
boleto deve 
ser superior a 
Parâmetro: 
valorDesconto
1 
O campo "valorDesconto1" foi preenchido com um 
valor igual ou menor que zero. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 34 
 
 
 
 
Classificação da informação: Uso Irrestrito 
zero, ou não 
informado. 
HTTP_BAD_REQUEST (400) 
 
O valor do 
segundo 
desconto do 
boleto deve 
ser superior a 
zero, ou não 
informado. 
Parâmetro: 
valorDesconto
2 
O campo "valorDesconto2" foi preenchido com um 
valor igual ou menor que zero. 
HTTP_BAD_REQUEST (400) 
 
O valor do 
terceiro 
desconto do 
boleto deve 
ser superior a 
zero, ou não 
informado. 
 
Parâmetro: 
valorDesconto
3 
O campo "valorDesconto3" foi preenchido com um 
valor igual ou menor que zero. 
HTTP_BAD_REQUEST (400) 
 
O valor de 
desconto 
antecipado do 
boleto deve 
ser superior a 
zero, ou não 
informado. 
Parâmetro: 
descontoAntec
ipado 
O campo "descontoAntecipado" foi preenchido com 
um valor igual ou menor que zero. 
 
HTTP_BAD_REQUEST (400) 
 
O campo 
documento do 
beneficiário 
final está 
inválido. 
Parâmetro: 
documento 
O campo "documento" (CPF/CNPJ) do beneficiário 
final foi preenchido de forma inválida. 
HTTP_BAD_REQUEST (400) 
 
O nome do 
beneficiário 
final permite 
até 40 
caracteres. 
Parâmetro: 
nome 
O campo "nome" do beneficiário final foi preenchido 
com mais de 40 caracteres. 
HTTP_BAD_REQUEST (400) 
 
O e-mail do 
beneficiário 
final permite 
até 40 
caracteres. 
Parâmetro: 
email 
O campo "email" do beneficiário final foi preenchido 
com mais de 40 caracteres. 
HTTP_BAD_REQUEST (400) 
 
O nome do 
pagador é 
obrigatório. 
Parâmetro: 
nome 
O campo "nome" do pagador não foi informado. 
HTTP_BAD_REQUEST (400) 
 
O nome do 
pagador 
permite até 40 
caracteres. 
Parâmetro: 
nome 
O campo "nome" do pagador foi preenchido com 
mais de 40 caracteres. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 35 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
 
O campo 
documento do 
pagador está 
inválido. 
Parâmetro: 
documento 
O campo "documento" do pagador (CPF/CNPJ) foi 
preenchido de forma inválida. Deve conter entre 11 
e 14 posições. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Beneficiário: 
XXXXXXXXXXX
XXX não tem 
contratado o 
serviço de 
Cobrança 
Online 
(ECOMM). 
 
Não possui 
O beneficiário não possui o produto Cobrança Online 
contratado. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Beneficiário: 
XXXXXXXXXXX
XXX esta com 
convenio 
encerrado. 
com a 
cooperativa. 
Não possui 
Necessário verificar com a cooperativa. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Híbrido não 
contratado. 
Favor solicitar 
a contratação. 
Não possui 
O campo tipoCobranca foi preenchido como 
"HIBRIDO". Entretanto, o beneficiário não possui o 
produto Pix contratado. Necessário contatar a 
cooperativa. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Documento do 
pagador não 
pode ser o 
mesmo do 
beneficiário 
final para 
espécie de 
documento 
DUPLICATA_M
ERCANTIL_IND
ICACA" 
Parâmetros: 
documento 
(pagador e 
beneficiario 
final) 
O campo "documento", tanto do pagador, quanto do 
beneficiário final, foram preenchidos com o mesmo 
CPF/CNPJ. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Documento do 
Beneficiário 
não pode ser o 
Parâmetro: 
documento 
(pagador) 
O campo "documento" do pagador foi preenchido 
com o mesmo CPF/CNPJ do beneficiário. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 36 
 
 
 
 
Classificação da informação: Uso Irrestrito 
mesmo do 
Pagador. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Tí-tulo com 
Protesto 
Automático, o 
beneficiário 
final precisa 
ser pessoa 
jurí-dica para 
espécie de 
documento 
DUPLICATA_M
ERCANTIL_IND
ICACAO 
Parâmetro: 
Documento 
(beneficiário 
final) 
Não foram informados os dados do beneficiário final. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Documento do 
Beneficiário 
não pode ser o 
mesmo do 
Beneficiário 
final. 
Parâmetro: 
documento 
(beneficiário 
final) 
O campo "documento" do beneficiário final foi 
preenchido com o mesmo CPF/CNPJ do beneficiário. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Data 
de vencimento 
tem que ser 
posterior ou 
igual a data 
atual. 
Parâmetro: 
dataVencimen
to 
O campo "dataVencimento" foi preenchido com uma 
data retroativa, ou seja, uma data anterior à data 
atual. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Espécie de 
documento 
não permite 
protesto / 
negativação. 
Parâmetro: 
especieDocum
ento 
O campo "especieDocumento" foi preenchido com: 
  
- Recibo 
- Nota de Débito 
- Outros 
- Boleto Proposta 
- Cartão de Crédito 
- Boleto Deposito 
  
Para essas espécies, não é permitido informar os 
campos "diasProtestoAuto" e 
"diasNegativacaoAuto". 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Não 
permite nem 
juros e nem 
multa para 
Espécie de 
documento 
Parâmetros: 
multa e juros 
Os campos "multa" e/ou "juros" foram informados 
para título com espécie Boleto Proposta. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 37 
 
 
 
 
Classificação da informação: Uso Irrestrito 
BOLETO_PROP
OSTA 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Valor 
do titulo deve 
ser maior que 
zero para 
espécie 
DUPLICATA_M
ERCANTIL_IND
ICACAO 
Parâmetro: 
valor 
O campo "valor" foi preenchido com um valor igual 
ou menor que zero. Só poderá ser preenchido com 
valor igual a zero caso a espécie do boleto seja: 
  
- Boleto Proposta 
- Cartão de Crédito 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Não 
permite juros 
maior ou igual 
ao valor do 
titulo para 
Espécie de 
documento 
DUPLICATA_M
ERCANTIL_IND
ICACAO 
Parâmetro: 
juros 
O campo "juros" foi preenchido com um valor maior 
ou igual ao valor do título. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Percentual 
juros deve ser 
menor que 
100% 
Parâmetro: 
juros 
O percentual de juros informado foi maior ou igual a 
100%. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: O 
valor da multa 
aplicada 
R$ X.XXXXXX 
não pode ser 
menor que 
R$ 0,01. 
Exemplo: Se o 
valor do título 
for de R$ 5,00 
e a multa for 
0,01%. O valor 
aplicado será 
de R$ 5,0005 e 
a multa 
aplicada será 
de R$ 0,0005 e 
isso não será 
permitido. 
Parâmetro: 
multa 
O campo "multa" (percentual) foi preenchido com 
um valor muito baixo, fazendo com que o cálculo da 
multa seja inferior a R$ 0,01. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: O 
valor de 
Parâmetro: 
O campo "valorDesconto1" foi preenchido com um 
valor maior ou igual ao título. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 38 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Desconto 1 
deve ser 
menor que o 
valor do 
boleto. 
valorDesconto
1 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: O 
valor de 
Desconto 2 
deve ser 
menor que o 
valor do 
boleto. 
Parâmetro: 
valorDesconto
2 
O campo "valorDesconto2" foi preenchido com um 
valor maior ou igual ao título. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: O 
valor de 
Desconto 3 
deve ser 
menor que o 
valor do 
boleto. 
Parâmetro: 
valorDesconto
3 
O campo "valorDesconto3" foi preenchido com um 
valor maior ou igual ao título. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Percentual 
desconto 1 
invalido: deve 
ser menor que 
100% 
Parâmetro: 
valorDesconto
1 
O percentual do desconto 1 foi preenchido com um 
valor maior ou igual a 100%. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Percentual 
desconto 2 
invalido: deve 
ser menor que 
100% 
Parâmetro: 
valorDesconto
2 
O percentual do desconto 2 foi preenchido com um 
valor maior ou igual a 100%. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Percentual 
desconto 3 
invalido: deve 
ser menor que 
100% 
Parâmetro: 
valorDesconto
3 
O percentual do desconto 3 foi preenchido com um 
valor maior ou igual a 100%. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Data 
de desconto 1 
não deve ser 
menor que 
data atual. 
Parâmetro: 
dataDesconto
1 
O campo "dataDesconto1" foi preenchido com uma 
data retroativa, ou seja, menor que a data atual. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Data 
de desconto 2 
não deve ser 
Parâmetro: 
dataDesconto
2 
O campo "dataDesconto2" foi preenchido com uma 
data retroativa, ou seja, menor que a data atual. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 39 
 
 
 
 
Classificação da informação: Uso Irrestrito 
menor que 
data atual. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Data 
de desconto 3 
não deve ser 
menor que 
data atual. 
Parâmetro: 
dataDesconto
3 
O campo "dataDesconto3" foi preenchido com uma 
data retroativa, ou seja, menor que a data atual. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Valor 
desconto 
antecipado 
invalido: 
maior/igual ao 
valor do titulo. 
Valor desconto 
antecipado 
calculado: 
XXX.XX 
Parâmetro: 
descontoAntec
ipado 
O campo "descontoAntecipado" foi preenchido com 
um valor que, após calculado, ficaria igual ou maior 
que o valor do título. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: Dias 
de negativação 
inválido para a 
UF de Mato 
Grosso do Sul. 
Para este 
estado o 
mí-nimo 
precisa ser 46 
e máximo 99. 
Parâmetro: 
diasNegativaca
oAuto 
O campo "diasNegativacaoAuto" não foi preenchido 
com valores entre 46 e 99. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: Não 
é permitido 
negativação e 
protesto 
automático 
simultaneame
nte. 
Parâmetros: 
diasNegativaca
oAuto e 
diasProtestoA
uto 
Os campos "diasNegativacaoAuto" e 
"diasProtestoAuto" foram preenchidos. É permitido 
somente um dos campos. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Beneficiário: 
XXXXXXXXXXX
XXX optou por 
validar CEP do 
pagador. O 
CEP: 
XXXXXXXX não 
foi localizado 
CEPs para o 
Parâmetro: 
cep 
O campo "cep" do pagador foi preenchido com um 
cep inválido. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 40 
 
 
 
 
Classificação da informação: Uso Irrestrito 
pagador com o 
documento: 
XXXXXXXXXXX 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: CEP 
do pagador 
esta inválido 
com protesto 
ou 
negativação 
automática 
Parâmetro: 
cep 
O campo "cep" do pagador foi preenchido com um 
cep inválido. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Beneficiário: 
XXXXXXXXXXX
XXX esta 
parametrizado 
como Terceiro 
Habilitado, 
deve ser 
enviado 
informações 
do beneficiário 
final. 
 
 
Não foram informados os dados do beneficiário final. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: Não 
permitido 
gerar QR Code 
para 
beneficiário 
que edita 
valor. Favor 
solicitar boleto 
normal. 
Parâmetro: 
tipoCobranca 
O campo "tipoCobranca" foi preenchido como 
beneficiário está configurado para permitir editar o 
valor, não é possível cadastrar boleto híbrido. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Beneficiário 
sem permissão 
com 
negativação 
Parâmetro: 
diasNegativaca
oAuto 
O campo "diasNegativacaoAuto" foi preenchido. 
produto Serasa ativo. 
 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
 
Negócio: 
Beneficiário 
final com 
situação 
inapto. 
Não se aplica 
 
HTTP_BAD_REQUEST (400) 
O repasse 
automático do 
é obrigatório e 
Parâmetro: 
repasseAutom
aticoSplit 
O parâmetro não foi enviado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 41 
 
 
 
 
Classificação da informação: Uso Irrestrito 
deve ser 
preenchido. 
HTTP_BAD_REQUEST (400) 
O repasse 
automático do 
deve ser SIM 
ou NÃO. 
Parâmetro: 
repasseAutom
aticoSplit 
O parâmetro foi preenchido com conteúdo diferente 
de SIM ou NÃO. 
HTTP_BAD_REQUEST (400) 
O campo tipo 
de valor do 
rateio é 
obrigatório e 
deve ser 
preenchido. 
Parâmetro: 
tipoValorRatei
o 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
O campo tipo 
de valor do 
rateio deve ser 
VALOR ou 
PERCENTUAL. 
Parâmetro: 
tipoValorRatei
o 
O parâmetro foi preenchido com conteúdo diferente 
de VALOR ou PERCENTUAL. 
HTTP_BAD_REQUEST (400) 
O campo de 
regra de rateio 
deve ser 
VALOR_COBRA
DO, 
VALOR_REGIST
RO ou 
MENOR_VALO
R. 
Parâmetro: 
regraRateio 
O parâmetro não foi enviado ou está inválido. 
HTTP_BAD_REQUEST (400) 
A lista 
destinatários 
não pode ser 
nula ou vazia e 
deve conter 
pelo menos 
um 
destinatário. 
Parâmetro: 
destinatarios 
O parâmetro não contém pelo menos um 
destinatário. 
HTTP_BAD_REQUEST (400) 
A lista 
destinatários 
deve conter no 
mínimo 1 
destinatário e 
no máximo 30 
destinatários. 
Parâmetro: 
destinatarios 
O parâmetro não contém pelo menos um 
destinatário. 
HTTP_BAD_REQUEST (400) 
banco é 
obrigatório 
aceita 
somente 
Parâmetro: 
codigoBanco 
O parâmetro foi preenchido com dados inválidos. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 42 
 
 
 
 
Classificação da informação: Uso Irrestrito 
caracteres 
numéricos e 
precisa conter 
informações 
válidas. 
HTTP_BAD_REQUEST (400) 
banco deve ter 
3 caracteres 
númericos. 
Parâmetro: 
codigoBanco 
O parâmetro foi preenchido com menos ou mais de 
3 caracteres. 
HTTP_BAD_REQUEST (400) 
agência é 
obrigatório 
Parâmetro: 
codigoAgencia 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
agência é 
obrigatório 
aceita 
somente 
caracteres 
numéricos e 
precisa conter 
informações 
válidas 
Parâmetro: 
codigoAgencia 
O parâmetro foi preenchido com dados inválidos. 
HTTP_BAD_REQUEST (400) 
agência deve 
ter 4 
caracteres 
númericos. 
Parâmetro: 
codigoAgencia 
O parâmetro foi preenchido com menos/mais de 4 
caracteres. 
HTTP_BAD_REQUEST (400) 
O número da 
conta corrente 
é obrigatório 
Parâmetro: 
numeroConta
Corrente 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
O número da 
conta corrente 
deve ter de 4 
até 13 
caracteres 
númericos. 
Parâmetro: 
numeroConta
Corrente 
O parâmetro foi preenchido com menos de 4 
caracteres ou mais de 13. 
HTTP_BAD_REQUEST (400) 
O número da 
conta é 
obrigatório 
aceita 
somente 
caracteres 
numéricos e 
precisa conter 
informações 
válidas 
Parâmetro: 
numeroConta
Corrente 
O parâmetro foi preenchido com dados inválidos. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 43 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
Documento 
(CPF|CNPJ) do 
destinatário é 
obrigatório 
Parâmetro: 
numeroCpfCn
pj 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
O CPF/CNPJ é 
obrigatório e 
aceita 
somente 
caracteres 
numéricos e 
precisa conter 
informações 
válidas 
Parâmetro: 
numeroCpfCn
pj 
O parâmetro foi preenchido com dados inválidos. 
HTTP_BAD_REQUEST (400) 
O nome do 
destinatário é 
obrigatório. 
Parâmetro: 
nomeDestinat
ario 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
O nome do 
destinatário 
permite de 3 
até 40 
caracteres. 
O nome do 
destinatário 
permite de 3 
até 40 
caracteres. 
O parâmetro foi preenchido com menos de 3 
caracteres ou mais de 40. 
HTTP_BAD_REQUEST (400) 
A parcela de 
rateio é 
obrigatória. 
Parâmetro: 
parcelaRateio 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
A sequencia 
de parcelas do 
rateio está 
incorreta. Essa 
sequencia 
deve ser de 1 
a 30 em 
ordem 
crescente. 
Parâmetro: 
parcelaRateio 
O parâmetro foi preenchido com dados inválidos. 
HTTP_BAD_REQUEST (400) 
O Valor de 
percentual de 
rateio é 
obrigatório. 
Parâmetro: 
valorPercentu
alRateio 
O parâmetro não foi enviado. 
HTTP_BAD_REQUEST (400) 
O valor de 
percentual de 
rateio deve ter 
até 16 dígitos, 
sendo dois 
deles para a 
casa decimal. 
Parâmetro: 
valorPercentu
alRateio 
O parâmetro foi preenchido com dados inválidos. 
HTTP_BAD_REQUEST (400) 
O float do split 
é obrigatório. 
Parâmetro: 
floatSplit 
O parâmetro não foi enviado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 44 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
A quantidade 
de dias do 
float deve ser 
de 1 a 30 dias. 
Parâmetro: 
floatSplit 
O parâmetro foi preenchido com dados inválidos. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: 
Quando o 
campo 
regraRateio for 
VALOR_COBRA
DO ou 
MENOR_VALO
R, o campo 
tipoValorRatei
o deverá ser 
PERCENTUAL. 
Parâmetros: 
regraRateio e 
tipoValorRatei
o 
Caso o campo regraRateio seja preenchido com os 
domínios VALOR_COBRADO ou MENOR_VALOR,  o 
campo tipoValorRateio deverá ser enviado com o 
domínio PERCENTUAL. 
HTTP_UNPROCESSABLE_ENTIT
Y (422) 
Negócio: Não 
é permitido o 
SPLIT para 
boletos com 
DESCONTO ou 
BOLETO 
PROPOSTA, 
com regra de 
rateio 
diferente de 
VALOR_COBRA
DO. 
Parâmetro: 
regraRateio 
Caso o campo regraRateio seja preenchido com o 
não poderá conter descontos, e a espécie do boleto 
deverá ser diferente de BOLETO_PROPOSTA. 
 
 
REQUEST – POST:  
URL Sandbox (Ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 45 
 
 
 
 
Classificação da informação: Uso Irrestrito 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos  
 
HEADERS: 
cooperativa 
posto 
Authorization 
x-api-key 
Content-Type: application/json 
 
REQUEST BODY (JSON): BOLETO TRADICIONAL 
      { 
   "beneficiarioFinal":{ 
      "cep":91250000, 
      "cidade":"PORTO ALEGRE", 
      "documento":"25140124069", 
      "logradouro":"RUA DOUTOR VARGAS NETO 980", 
      "nome":"FELIPE OLIVEIRA", 
      "numeroEndereco":119, 
      "tipoPessoa":"PESSOA_FISICA", 
      "uf":"RS" 
   }, 
   "codigoBeneficiario":"12345", 
   "dataVencimento":"2022-07-30", 
   "especieDocumento":"DUPLICATA_MERCANTIL_INDICACAO", 
   "pagador":{ 
      "cep":"91250000", 
      "cidade":"PORTO ALEGRE", 
      "documento":"02738306006", 
      "nome":"RODRIGO OLIVEIRA", 
      "tipoPessoa":"PESSOA_FISICA", 
      "endereco":"RUA DOUTOR VARGAS 150", 
      "uf":"RS" 
   }, 
   "tipoCobranca": "NORMAL", 
   "nossoNumero": 600046210, 
   "seuNumero":"TESTE", 
   "valor":50.00, 
   "tipoDesconto": "VALOR", 
   "valorDesconto1":10.00, 
   "dataDesconto1":"2022-07-15", 
   "valorDesconto2":7.00, 
   "dataDesconto2":"2022-07-20", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 46 
 
 
 
 
Classificação da informação: Uso Irrestrito 
   "valorDesconto3":3.00, 
   "dataDesconto3":"2022-07-30", 
   "tipoJuros": "VALOR", 
   "tipoJurosPercentual": "DIARIO", 
   "juros": 5.00, 
   "dataInicioJuros":"2025-11-26", 
   "tipoMulta": "PERCENTUAL", 
   "multa": 3.00, 
   "dataInicioMulta":"2025-11-26", 
   "informativos": [ 
    "info 1", 
    "info 2", 
    "info 3", 
    "info 4", 
    "info 5" 
  ], 
  "mensagens": [ 
    "mens 1", 
    "mens 2", 
    "mens 3", 
    "mens 4" 
  ] 
} 
 
RESPONSE BODY (JSON):  
{ 
    "txid": null, 
    "qrCode": null, 
    "linhaDigitavel": "74891125110061420512803153351030188640000009990", 
    "codigoBarras": "74891886400000099901125100614205120315335103", 
    "cooperativa": "0512", 
    "posto": "03", 
    "nossoNumero": "251006142" 
     } 
 
REQUEST BODY (JSON): BOLETO HÍBRIDO 
      { 
   "beneficiarioFinal":{ 
      "cep":91250000, 
      "cidade":"PORTO ALEGRE", 
      "documento":"25140124069", 
      "logradouro":"RUA DOUTOR VARGAS 980", 
      "nome":"FELIPE OLIVEIRA", 
      "numeroEndereco":119, 
      "tipoPessoa":"PESSOA_FISICA", 
      "uf":"RS" 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 47 
 
 
 
 
Classificação da informação: Uso Irrestrito 
   }, 
   "codigoBeneficiario":"12345", 
   "dataVencimento":"2022-07-30", 
   "especieDocumento":"DUPLICATA_MERCANTIL_INDICACAO", 
   "pagador":{ 
      "cep":"91250000", 
      "cidade":"PORTO ALEGRE", 
      "documento":"02738306006", 
      "nome":"RODRIGO OLIVEIRA", 
      "tipoPessoa":"PESSOA_FISICA", 
      "endereco":"RUA DOUTOR VARGAS NETO 150", 
      "uf":"RS" 
   }, 
   "tipoCobranca":"HIBRIDO", 
   "nossoNumero": 600046210, 
   "seuNumero":"TESTE", 
   "valor":50.00, 
   "tipoDesconto": "VALOR", 
   "valorDesconto1":10.00, 
   "dataDesconto1":"2022-07-15", 
   "valorDesconto2":7.00, 
   "dataDesconto2":"2022-07-20", 
   "valorDesconto3":3.00, 
   "dataDesconto3":"2022-07-30", 
   "tipoJuros": "VALOR", 
   "tipoJurosPercentual": "DIARIO", 
   "juros": 5.00, 
   "dataInicioJuros":"2025-11-26", 
   "tipoMulta": "PERCENTUAL", 
   "multa": 3.00, 
   "dataInicioMulta":"2025-11-26",   
   "informativos": [ 
    "info 1", 
    "info 2", 
    "info 3", 
    "info 4", 
    "info 5" 
   ], 
  "mensagens": [ 
    "mens 1", 
    "mens 2", 
    "mens 3", 
    "mens 4" 
  ] 
} 
 
RESPONSE BODY (JSON): 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 48 
 
 
 
 
Classificação da informação: Uso Irrestrito 
{ 
    "txid": "f69d2a0076fb4ea2bddd7babd1200525", 
    "qrCode": "00020101021226930014br.gov.bcb.pix2571pix-qrcode-
h.sicredi.com.br/qr/v2/cobv/6946459e4b6e4c19ab5c9689fe0df30a520400005303986540599.905802BR592
1OLIVEIRA MULTI MARCAS6008BRASILIA62070503***6304E5E1", 
    "linhaDigitavel": "74891125110061420512803153351030188640000009990", 
    "codigoBarras": "74891886400000099901125100614205120315335103", 
    "cooperativa": "0512", 
    "posto": "03", 
    "nossoNumero": "251006142" 
     } 
 
REQUEST BODY (JSON): BOLETO COM SPLIT 
{ 
   "beneficiarioFinal":{ 
      "cep":91250000, 
      "cidade":"PORTO ALEGRE", 
      "documento":"25140124068", 
      "logradouro":"RUA DOUTOR VARGAS NETO 980", 
      "nome":"FELIPE OLIVEIRA", 
      "numeroEndereco":119, 
      "tipoPessoa":"PESSOA_FISICA", 
      "uf":"RS" 
   }, 
   "codigoBeneficiario":"94787", 
   "dataVencimento":"2023-07-30", 
   "especieDocumento":"DUPLICATA_MERCANTIL_INDICACAO", 
   "pagador":{ 
      "cep":"91250000", 
      "cidade":"PORTO ALEGRE", 
      "documento":"02738306004", 
      "nome":"RODRIGO OLIVEIRA", 
      "tipoPessoa":"PESSOA_FISICA", 
      "endereco":"RUA DOUTOR VARGAS 150", 
      "uf":"RS" 
   }, 
   "tipoCobranca": "NORMAL", 
   "nossoNumero": 600046210, 
   "seuNumero":"TESTE", 
   "valor":50.00, 
   "tipoDesconto": "VALOR", 
   "valorDesconto1":10.00, 
   "dataDesconto1":"2023-07-15", 
   "valorDesconto2":7.00, 
   "dataDesconto2":"2023-07-20", 
   "valorDesconto3":3.00, 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 49 
 
 
 
 
Classificação da informação: Uso Irrestrito 
   "dataDesconto3":"2023-07-30", 
   "tipoJuros": "VALOR", 
   "tipoJurosPercentual": "DIARIO", 
   "juros": 5.00, 
   "dataInicioJuros":"2025-11-26", 
   "tipoMulta": "PERCENTUAL", 
   "multa": 3.00, 
   "dataInicioMulta":"2025-11-26",    
   "informativos": [ 
    "info 1", 
    "info 2", 
    "info 3", 
    "info 4", 
    "info 5" 
  ], 
  "mensagens": [ 
    "mens 1", 
    "mens 2", 
    "mens 3", 
    "mens 4" 
  ], 
    "splitBoleto": { 
       "repasseAutomaticoSplit": "SIM", 
       "tipoValorRateio": "PERCENTUAL", 
       "regraRateio": "VALOR_COBRADO", 
       "destinatarios":[ 
           { 
               "codigoBanco": "237", 
               "codigoAgencia": "0434", 
               "numeroContaCorrente": "2323232323", 
               "numeroCpfCnpj": "02738306004", 
               "nomeDestinatario": "DECIO OLIVEIRA", 
               "parcelaRateio": "1", 
               "valorPercentualRateio": 24.22, 
               "floatSplit": 20 
           } 
           ] 
    } 
         
} 
Execução (via ferramenta Postman) 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 50 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
saída será arquivo binário (octet-stream), em caso de sucesso, e JSON, em caso de falha. 
Entrada: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 51 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro  
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderParam  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  String   HeaderParam   
1413 
Obrigatório 
 
3  
linhaDigitavel   String   QueryParam   
47 
Sem formatação 
digitável do boleto.   
Obrigatório  
 
 
 
Para salvar o boleto, via postman, deverá clicar na opção “Download” 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 52 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
RETORNO (Response): 
Descrição  
HTTP_CREATED (201)  
Operação criada com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401)  
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios 
não informados ou 
inválidos.  
 
HTTP_UNAUTHORIZED (401)  
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetros obrigatórios 
não informados ou 
inválidos.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 53 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401)  
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
linhaDigitavel 
linha digitável informada 
é de beneficiário e/ou 
agência diferente. 
HTTP_BAD_REQUEST (400)   
A linha digitavel 
deve ter 47 dígitos.   
Parâmetro:  
linhaDigitavel  
parâmetros obrigatórios 
não informados ou 
inválidos.   
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Boleto não 
localizado. Verifique 
os dados informados 
ou entre em contato 
com o Beneficiário. 
Parâmetro: 
linhaDigitavel 
o boleto não é localizado 
através da linha digitável 
informada. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests 
são enviadas muitas 
requisições em um 
determinado período de 
tempo. 
 
REQUEST – GET:  
URL Sandbox (ambiente para homologação):  
URL Produção:  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
 
PARAM: 
LinhaDigitavel 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 54 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
 
Parâmetros:  
 
Headers:  
 
 
Cenário Positivo:  
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 55 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 400 – BAD_REQUEST 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 56 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é composta da 
 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório   
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 57 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
posto 
String 
Header 
2 
Sem 
formatação 
posto  do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String (date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 58 
 
 
 
 
Classificação da informação: Uso Irrestrito 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi  informado 
ou está inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 59 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 60 
 
 
 
 
Classificação da informação: Uso Irrestrito 
BODY: 
{ } 
PATCH: 
nossoNumero 
Execução (via ferramenta Postman) 
HEADERS:  
 
 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 61 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Cenário Positivo:  
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 62 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 63 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Vencimento 
de vencimento do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é 
 
Entrada: 
Ord  
Nome  
Tipo  
Tipo 
de  
Parâme
tro  
 
Tamanho 
Formatação  
Descrição  
Obrigat
ório  
1  
x-api-key  
String  
Header
Param  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigat
ório  
2   
authorization  
String   
Header 
 
1413 
obtido na 
Obrigat
ório   
3 
Content-Type 
application/
json 
Header 
Sem formatação 
Tipo conteúdo Obrigat
ório 
4   
cooperativa   
String   
Header 
 
4 
Sem formatação 
cooperativa do 
beneficiário  
Obrigat
ório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 64 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
Posto 
String 
Header 
2 
Sem formatação 
agência do 
beneficiário 
Obrigat
ório 
6 
codigoBeneficiario String 
Header 
5 
Sem formatação 
beneficiário 
Obrigat
ório 
7 
dataVencimento 
String 
(date) 
Body 
10 
YYYY-MM-DD 
Data de 
vencimento do 
boleto 
Obrigat
ório 
8 
nossoNumero 
String 
Patch 
9 
Sem formatação 
Nosso Número Obrigat
ório 
 
 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 65 
 
 
 
 
Classificação da informação: Uso Irrestrito 
9 
tipoMensagem 
String 
17 
Sem 
formatação 
 
ALTERA_VENCIMENTO 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
Importante: Quando os beneficiários alterarem a data de vencimento dos boletos que possuam campos 
de carência para início de juros e/ou multa, o sistema atualizará tanto a data de vencimento quanto as 
datas de carência, preservando a mesma diferença de dias entre elas. 
Exemplo: 
Se a data de vencimento original for 10/01/2025 e a data de início da cobrança de juros for 20/01/2025, 
ao alterar o vencimento para 15/01/2025, a data de início da cobrança de juros será ajustada para 
25/01/2025, mantendo o intervalo de 10 dias. 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 66 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_BAD_REQUEST (400) 
A data de 
vencimento do 
boleto é 
obrigatória e deve 
ser preenchida. 
Parâmetro: 
dataVencimento 
data de vencimento não é 
informada ou inválida. 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: 
Vencimento não 
deve ser inferior a 
DD/MM/YYYY. 
Parâmetro: 
dataVencimento 
data de vencimento 
informada é retroativa. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 67 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/data-vencimento 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/data-vencimento 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{“dataVencimento”: “XXXX-MM-DD”} 
PATCH: 
nossoNumero 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 68 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
 
Headers:  
 
 
Body:  
 
 
Cenário Positivo:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 69 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 70 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 71 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Desconto 
valor/percentual de desconto do boleto. O formato de entrada e saída é JSON, considerando que a saída 
milissegundos. 
 
Entrada: 
Ord  
Nome  
Tipo  
Tipo 
de  
Parâme
tro  
 
Tamanho 
Formatação  
Descrição  
Obrigat
ório  
1  
x-api-key  
String  
Header
Param  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigat
ório  
2   
authorization  
String   
Header 
 
1413 
obtido na 
Obrigat
ório   
3 
Content-Type 
application/
json 
Header 
Sem formatação 
Tipo conteúdo Obrigat
ório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 72 
 
 
 
 
Classificação da informação: Uso Irrestrito 
4   
cooperativa   
String   
Header 
 
4 
Sem formatação 
cooperativa do 
beneficiário  
Obrigat
ório  
5 
Posto 
String 
Header 
2 
Sem formatação 
agência do 
beneficiário 
Obrigat
ório 
6 
codigoBeneficiario String 
Header 
5 
Sem formatação 
beneficiário 
Obrigat
ório 
7 
nossoNumero 
String 
Patch 
9 
Sem formatação 
Nosso Número Obrigat
ório 
8 
valorDesconto1 
Number 
Body 
14,2 
Sem formatação 
Valor do 
desconto 1. 
Deverá ser 
informado ao 
menos um dos 
três descontos. 
Opcion
al 
9 
valorDesconto2 
Number 
Body 
14,2 
Sem formatação 
Valor do 
desconto 2. 
Deverá ser 
informado ao 
menos um dos 
três descontos. 
Opcion
al 
10 
valorDesconto3 
Number 
Body 
14,2 
Sem formatação 
Valor do 
desconto 3. 
Deverá ser 
informado ao 
menos um dos 
três descontos. 
Opcion
al 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 73 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
21 
Sem 
formatação 
 
ALTERA_VALOR_DESCONTO 
 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 74 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 
HTTP_BAD_REQUEST (400) 
O valor do 
primeiro desconto 
do boleto deve ser 
superior a zero, ou 
não informado. 
Parâmetro: 
valorDesconto1 
valor do primeiro desconto 
está zerado (0.00). 
HTTP_BAD_REQUEST (400) 
O valor do 
segundo desconto 
do boleto deve ser 
superior a zero, ou 
não informado. 
valorDesconto2 
valor do segundo desconto 
está zerado (0.00). 
HTTP_BAD_REQUEST (400) 
O valor do terceiro 
desconto do boleto 
deve ser superior a 
zero, ou não 
informado. 
valorDesconto3 
valor do terceiro desconto 
está zerado (0.00). 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: 
Necessário 
informar pelo 
menos um dos 
descontos. 
Não se aplica 
não é informado pelo 
menos um dos três 
descontos. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 75 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/desconto 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 76 
 
 
 
 
Classificação da informação: Uso Irrestrito 
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/desconto 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ 
  "valorDesconto1": 0.00, 
  "valorDesconto2": 0.00, 
  "valorDesconto3": 0.00 
} 
PATCH: 
nossoNumero 
Execução (via ferramenta Postman) 
 
Headers:  
 
Body:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 77 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Positivo:  
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 78 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Cenário Negativo: 400 – BAD_REQUEST 
 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 79 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 80 
 
 
 
 
Classificação da informação: Uso Irrestrito 
de Desconto 
milissegundos. 
 
 
 
Entrada: 
Ord  
Nome  
Tipo  
Tipo 
de  
Parâme
tro  
 
Tamanho 
Formatação  
Descrição  
Obrigat
ório  
1  
x-api-key  
String  
Header
Param  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigat
ório  
2   
authorization  
String   
Header 
 
1413 
obtido na 
Obrigat
ório   
3 
Content-Type 
application/
json 
Header 
Sem formatação 
Tipo conteúdo Obrigat
ório 
4   
cooperativa   
String   
Header 
 
4 
Sem formatação 
cooperativa do 
beneficiário  
Obrigat
ório  
5 
Posto 
String 
Header 
2 
Sem formatação 
agência do 
beneficiário 
Obrigat
ório 
6 
codigoBeneficiario String 
Header 
5 
Sem formatação 
beneficiário 
Obrigat
ório 
7 
nossoNumero 
String 
Patch 
9 
Sem formatação 
Nosso Número Obrigat
ório 
8 
data1 
String (date) Body 
10 
YYYY-MM-DD 
Data do 
desconto 1. 
Deverá ser 
Opcion
al 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 81 
 
 
 
 
Classificação da informação: Uso Irrestrito 
informado ao 
menos uma 
das três datas. 
9 
data2 
String (date) Body 
10 
YYYY-MM-DD 
Data do 
desconto 2. 
Deverá ser 
informado ao 
menos uma 
das três datas. 
Opcion
al 
10 
data3 
String (date) Body 
10 
YYYY-MM-DD 
Data do 
desconto 3. 
Deverá ser 
informado ao 
menos uma 
das três datas. 
Opcion
al 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 82 
 
 
 
 
Classificação da informação: Uso Irrestrito 
9 
tipoMensagem 
String 
20 
Sem 
formatação 
 
ALTERA_DATA_DESCONTO 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
 
 
 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 83 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: 
Necessário 
informar pelo 
menos um dos 
descontos. 
Não se aplica 
não é informado ao menos 
uma das três datas de 
desconto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: A data 
de desconto 2 deve 
ser posterior a data 
de desconto 1. 
Parâmetro: 
data2 
data de desconto 2 é 
anterior à data de desconto 
1. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: A data 
de desconto 3 deve 
ser posterior a data 
de desconto 2. 
Parâmetro: 
data3 
data de desconto 3 é 
anterior à data de desconto 
2. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 84 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/data-desconto 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/data-desconto 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ 
  "data1": "YYYY-MM-DD", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 85 
 
 
 
 
Classificação da informação: Uso Irrestrito 
  "data2": "YYYY-MM-DD", 
  "data3": "YYYY-MM-DD" 
} 
PATCH: 
nossoNumero 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Execução (via ferramenta Postman) 
Headers: 
 
 
Body:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 86 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Positivo:  
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 87 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 88 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
Juros 
valor/percentual de juros do boleto. O formato de entrada e saída é JSON, considerando que a saída 
milissegundos. 
 
Entrada: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 89 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Ord  
Nome  
Tipo  
Tipo 
de  
Parâme
tro  
 
Tamanho 
Formatação  
Descrição  
Obrigat
ório  
1  
x-api-key  
String  
Header
Param  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigat
ório  
2   
authorization  
String   
Header 
 
1413 
obtido na 
Obrigat
ório   
3 
Content-Type 
application/
json 
Header 
Sem formatação 
Tipo conteúdo Obrigat
ório 
4   
cooperativa   
String   
Header 
 
4 
Sem formatação 
cooperativa do 
beneficiário  
Obrigat
ório  
5 
Posto 
String 
Header 
2 
Sem formatação 
agência do 
beneficiário 
Obrigat
ório 
6 
codigoBeneficiario String 
Header 
5 
Sem formatação 
beneficiário 
Obrigat
ório 
7 
nossoNumero 
String 
Patch 
9 
Sem formatação 
Nosso Número Obrigat
ório 
8 
valorOuPercentual Number 
Body 
14,2 
Sem formatação 
Valor ou 
percentual de 
juros do boleto 
Obrigat
ório 
 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 90 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
12 
Sem 
formatação 
 
ALTERA_JUROS 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
Importante:  
Apenas o valor dos juros poderá ser alterado; o tipo de juro permanecerá inalterado. 
 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 91 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 
HTTP_BAD_REQUEST (400) 
O valor ou 
percentual é 
obrigatório e deve 
ser preenchido. 
Parâmetro: 
valorOuPercentual 
parâmetro não foi 
informado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 92 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/juros 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/juros 
 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 93 
 
 
 
 
Classificação da informação: Uso Irrestrito 
codigoBeneficiario 
 
BODY: 
{ 
  "valorOuPercentual": "0.00" 
} 
PATCH: 
nossoNumero 
Execução (via ferramenta Postman) 
 
Headers:  
 
 
 
Body: 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 94 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Positivo:  
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 95 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 400 – BAD_REQUEST 
 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 96 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Número 
do Seu Número do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é 
Entrada: 
Ord  
Nome  
Tipo  
Tipo 
de  
Parâme
tro  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
Header
Param  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigatório  
2   
authorization  
String   
Header 
 
1413 
obtido na 
Obrigatório   
3 
Content-Type 
application/
json 
Header 
Sem formatação 
Tipo conteúdo Obrigatório 
4   
cooperativa   
String   
Header 
 
4 
Sem formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
Posto 
String 
Header 
2 
Sem formatação 
posto do 
beneficiário 
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 97 
 
 
 
 
Classificação da informação: Uso Irrestrito 
6 
codigoBeneficiario String 
Header 
5 
Sem formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem formatação 
Nosso Número Obrigatório 
8 
seuNumero 
String 
Body 
10 
Sem formatação 
Seu número 
do boleto. 
Normalmente 
usado neste 
campo o 
número da 
nota fiscal 
gerada para o 
pagador. 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 98 
 
 
 
 
Classificação da informação: Uso Irrestrito 
9 
tipoMensagem 
String 
16 
Sem 
formatação 
 
ALTERA_SEUNUMERO 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_BAD_REQUEST (400) 
Título não 
encontrado 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 99 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
O campo seu 
numero deve ter 
entre 1 (um) e 10 
(dez) caracteres. 
Parâmetro: 
seuNumero 
parâmetro foi preenchido 
com mais de 10 caracteres 
ou não foi informado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
rejeitado. 
Não se aplica 
título está rejeitado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título já 
liquidado. 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Operação não 
permitida: Título 
negativação ou 
protesto. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/seu-numero 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 100 
 
 
 
 
Classificação da informação: Uso Irrestrito 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/seu-numero 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ 
  "seuNumero": "0123456789" 
} 
PATCH: 
nossoNumero 
 
Execução (via ferramenta Postman) 
Headers:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 101 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Body:  
 
Cenário Positivo: 
 
Cenário Negativo: 401 – UNAUTHORIZED
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 102 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Cenário Negativo: 400 – BAD_REQUEST 
 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 103 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
Abatimento  
conceder um valor de abatimento para um boleto. O formato de entrada e saída é JSON, considerando 
em milissegundos. 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 104 
 
 
 
 
Classificação da informação: Uso Irrestrito 
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
8 
valorAbatimento 
String 
Body 
14,2 
Sem 
formatação 
Valor (Real) de 
abatimento a ser 
concedido no 
boleto. 
Obrigatório 
 
 
 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 105 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
beneficiário 
7 
String  
17 
Sem 
formatação  
será: 
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
16 
Sem 
formatação 
 
PEDIDO_ABATIMENTO 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
 
 
 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 106 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 
HTTP_BAD_REQUEST (400) 
inválida: Título não 
encontrado. (Título 
não encontrado). 
Parâmetro: 
nossoNumero 
nosso número informado 
não foi encontrado. 
HTTP_BAD_REQUEST (400) 
inválida: título já 
abatimento 
concedido. 
Parâmetro: 
nossoNumero 
título já possui uma 
concedida. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação. 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado. 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título 
enviado para 
Cartório/Serasa. 
Não se aplica 
negativação/protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
010- Valor de 
abatimento 
inválido 
Não se aplica 
valor de abatimento 
informado é inválido. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 107 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova 
um boleto que está com a 
solicitação anterior em 
processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/conceder-
abatimento  
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/conceder-abatimento  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
 
BODY: 
{  
"valorAbatimento": "12.34" 
}  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 108 
 
 
 
 
Classificação da informação: Uso Irrestrito 
PathParam: 
nossoNumero 
Execução (via ferramenta Postman) 
Headers:  
 
 
Body:  
 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 109 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 110 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
Abatimento Concedido 
cancelar o abatimento concedido para um boleto que possui abatimento vinculado. O formato de 
entrada e saída é JSON, considerando que a saída sempre é composta da entidade a ser retornada e um 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   Authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 111 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
6 
posto  
String  
2 
Sem 
formatação  
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
PEDIDO_CANCELAMENTO_ABATIMENTO 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 112 
 
 
 
 
Classificação da informação: Uso Irrestrito 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: não existe 
Concessão de 
Abatimento." 
Não se aplica 
título não possui abatimento 
vinculado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 113 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/cancelar-
abatimento  
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/cancelar-abatimento  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
 
BODY: 
{ }  
PathParam: 
nossoNumero 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 114 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
Headers:  
 
 
Body:  
 
OBS: O body permanece vazio, conforme imagem acima. 
Cenário Positivo:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 115 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 
 
Protesto 
protesto para um boleto vencido. O formato de entrada e saída é JSON, considerando que a saída sempre 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 116 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 117 
 
 
 
 
Classificação da informação: Uso Irrestrito 
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String (date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
PEDIDO_PROTESTO 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 118 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: espécie de 
documento não 
permite Protesto 
de Títulos." 
Não se aplica 
título possui uma espécie de 
documento que não permite 
pedido de protesto. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título 
enviado para 
Cartório." 
Não se aplica 
título já possui um pedido de 
protesto em andamento. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
Não se aplica 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título 
ainda não venceu." 
Não se aplica 
protesto para um título ainda 
não vencido. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 119 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/protesto 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/protesto  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ } 
PathParam: 
nossoNumero 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 120 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
HEADERS:  
 
 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 
Cenário Positivo:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 121 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 401 – UNAUTHORIZED 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 122 
 
 
 
 
Classificação da informação: Uso Irrestrito 
entrada e saída é JSON, considerando que a saída sempre é composta da entidade a ser retornada e um 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 123 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String (date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 124 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título não 
foi encaminhado 
para Cartório.” 
Não se aplica 
título não possui nenhuma 
seja comandada a sustação. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
"0131 - Operação 
não permitida para 
o tipo de carteira 
Descontada." 
Não se aplica 
título está vinculado a uma 
operação de crédito. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-protesto-


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 125 
 
 
 
 
Classificação da informação: Uso Irrestrito 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-protesto-
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ } 
PathParam: 
nossoNumero 
Execução (via ferramenta Postman) 
 
HEADERS:  
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 126 
 
 
 
 
Classificação da informação: Uso Irrestrito 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 
 
Cenário Positivo:  
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 127 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 
 
 
e Manter Título 
de entrada e saída é JSON, considerando que a saída sempre é composta da entidade a ser retornada e 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 128 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
6 
posto  
String  
2 
Sem 
formatação  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 129 
 
 
 
 
Classificação da informação: Uso Irrestrito 
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String (date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
PEDIDO_SUSTAR_MANTER_PROTESTO 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 130 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título não 
foi encaminhado 
para Cartório.” 
Não se aplica 
título não possui nenhuma 
seja comandada a sustação. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
"0131 - Operação 
não permitida para 
o tipo de carteira 
Descontada." 
Não se aplica 
título está vinculado a uma 
operação de crédito. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-protesto-
manter-titulo 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 131 
 
 
 
 
Classificação da informação: Uso Irrestrito 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-protesto-
manter-titulo  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
BODY: 
{ } 
PathParam: 
nossoNumero 
Execução (via ferramenta Postman) 
 
HEADERS:  
 
 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 132 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Positivo:  
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 133 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
Negativação 
inclui um pedido de negativação para um boleto vencido. O formato de entrada e saída é JSON, 
um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão o recurso 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 134 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
beneficiário 
6 
posto  
String  
2 
Sem 
formatação  
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String (date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
PEDIDO_NEGATIVACAO 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 135 
 
 
 
 
Classificação da informação: Uso Irrestrito 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título 
ainda não venceu.” 
Não se aplica 
título não possui nenhuma 
seja comandada a sustação. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
"0131 - Operação 
não permitida para 
o tipo de carteira 
Descontada." 
Não se aplica 
título está vinculado a uma 
operação de crédito. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 136 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/negativacao 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/negativacao  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
 
BODY: 
{ } 
PathParam: 
nossoNumero 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 137 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
 
HEADERS:  
 
 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 
 
Cenário Positivo:  
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 138 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 401 – UNAUTHORIZED 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 139 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP dentro de um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 
10 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 140 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
codigoBeneficiario 
String 
5 
Sem 
formatação 
4 
nossoNumero  
String  
9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  
4 
Sem 
formatação  
6 
posto  
String  
2 
Sem 
formatação  
7 
String  
17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 141 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
“0285 - Título sem 
negativação. Favor 
verificar.” 
Não se aplica 
título não possui nenhuma 
seja comandada a sustação. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
"0131 - Operação 
não permitida para 
o tipo de carteira 
Descontada." 
Não se aplica 
título está vinculado a uma 
operação de crédito. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 142 
 
 
 
 
Classificação da informação: Uso Irrestrito 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/sustar-negativacao-
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
 
BODY: 
{ } 
PathParam: 
nossoNumero 
Execução (via ferramenta Postman) 
 
HEADERS:  
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 143 
 
 
 
 
Classificação da informação: Uso Irrestrito 
BODY:  
 
OBS: O body permanece vazio, conforme imagem acima. 
Cenário Positivo:  
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 144 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 145 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Protesto Automático 
cancelar o protesto automático de um título que tenha protesto vinculado. O formato de entrada e 
HTTP dentro de um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
 
Tamanho Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   Authorization  
String   
Header   
1413 
Bearer + 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/jso
n 
Header 
Sem 
formatação 
Tipo conteúdo 
Obrigatório 
4   cooperativa   
String   
Header   
4 
Sem 
formatação 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
Sem 
formatação 
do beneficiário 
Obrigatório 
6 
codigoBeneficiario 
String 
Header 
5 
Sem 
formatação 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Path 
9 
Sem 
formatação 
Nosso Número 
Obrigatório 
 
Saída: 
Ord Nome 
Tipo 
Tamanho Formatação Descrição 
1  
transactionId 
string 
36 
Sem 
formatação  
Identificador da transação 
2 
dataMovimento 
String 10 
Sem 
formatação 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 146 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
codigoBeneficiario String 
5 
Sem 
formatação 
4 
nossoNumero  
String  9 
Sem 
formatação 
Nosso Número 
5 
cooperativa  
String  4 
Sem 
formatação  
6 
posto  
String  2 
Sem 
formatação  
7 
String  17 
Sem 
formatação  
 
- MOVIMENTO_ENVIADO 
8 
dataHoraRegistro 
String 
(date-
time) 
26 
Sem 
formatação 
9 
tipoMensagem 
String 
5 
Sem 
formatação 
 
PEDIDO_CANCELAMENTO_PROTESTO_AUTOMATICO 
 
Descrição  
HTTP_ACCEPTED (202)  
Operação recebida com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro não foi informado 
ou está inválido. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 147 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
(authorization). 
HTTP_BAD_REQUEST (422) 
“0017 - Título não 
cadastrado.” 
Parâmetro: 
nossoNumero 
nosso número informado não 
foi encontrado ou não existe. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título está 
aguardando 
confirmação.” 
Não se aplica 
título está aguardando 
confirmação de entrada. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
" 068-Instrucao 
invalida: Título 
enviado para 
Cartório." 
Não se aplica 
título não possui abatimento 
vinculado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
inválida: título já 
liquidado." 
Não se aplica 
título está liquidado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Sua solicitação 
anterior está em 
processamento, 
aguarde alguns 
instantes. 
Não se aplica 
realizada uma nova tentativa 
que está com a solicitação 
anterior em processamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
enviadas muitas requisições 
em um curto espaço de 
tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente de homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/cancelar-protesto-
automatico  
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 148 
 
 
 
 
Classificação da informação: Uso Irrestrito 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/cancelar-protesto-
automatico  
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
codigoBeneficiario 
 
 
BODY: 
{ }  
PathParam: 
nossoNumero 
 
Execução (via ferramenta Postman) 
Headers:  
 
 
Body:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 149 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
OBS: O body permanece vazio, conforme imagem acima. 
Cenário Positivo:  
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 150 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
boleto, através do Nosso Número. O formato de entrada e saída é JSON, considerando que a saída sempre 
▪ 
atualmente uma nova versão (“v2”) com as seguintes diferenças: 
▪ Novo header (data-movimento) do tipo bollean que ao ser informado = 
“true” retorna a data do movimento de liquidação utilizando o próximo 
dia útil. Na “v1” quando as liquidações ocorrem em finais de semana e/ou 
feriados a data de liquidação apresentada é o dia em que ocorreu a 
liquidação, sem considerar o próximo dia útil. Abaixo segue mais detalhes 
sobre o novo header (Ord 8). 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
Header  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 151 
 
 
 
 
Classificação da informação: Uso Irrestrito 
2   
authorization  
String   
Header   
1413 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/
json 
Header 
Sem formatação Tipo conteúdo 
Obrigatório 
4   
cooperativa   
String   
Header   
4 
cooperativa do 
beneficiário  
Obrigatório  
5 
Posto 
String 
Header 
2 
agência do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Param 
5 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Param 
9 
Sem formatação Nosso Número Obrigatório 
8 
data-movimento 
Boolean 
HeaderPar
am  
true / 
false 
Sem formatação Obs: Esse 
header só deve 
ser informado 
caso esteja 
utilizando o 
endpoint “v2”.  
Responsável por 
apresentar a 
data de 
movimento da 
liquidação 
utilizando 
próximo dia útil 
quando 
liquidações são 
efetuadas em 
dias não úteis. 
 
Opções:  
- true  
(retorna campo 
“dataMovimento
”) 
- false  
Opcional 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 152 
 
 
 
 
Classificação da informação: Uso Irrestrito 
(não retorna o 
campo 
“dataMovimento
”) 
 
 
Saída: 
Ord Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
linhaDigitavel 
String 
47 
Sem formatação  
Linha digitável 
do boleto 
2 
codigoBarras 
String 
44 
Sem formatação 
do boleto 
3 
carteira 
String 
 
Sem formatação 
Tipo de carteira, 
podendo ser: 
 
A – SIMPLES 
B – 
CAUCIONADA 
C – 
DESCONTADA 
D – VINCULADA 
4 
seuNumero 
String  
10 
Sem formatação 
Seu Número 
5 
nossoNumero 
String  
9 
Sem formatação  
Nosso Número 
6 
Pagador 
 
(Grupo com os dados 
do pagador) 
codigo 
String 
5 
Sem formatação 
Codigo do 
pagador 
 
documento 
String 
14 
Sem formatação 
Documento do 
pagador 
 
nome 
String 
40 
Sem formatação 
Nome do 
pagador 
7 
beneficiarioFinal 
 
(Grupo com os dados 
do beneficiário final) 
 
OBS: Caso não exista 
beneficiário final 
codigo 
String 
3 
Sem formatação 
beneficiário final 
 
 
documento 
String 
14 
Sem formatação 
Documento do 
beneficiário final 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 153 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
vinculado ao boleto, o 
grupo não será exibido. 
nome 
String 
40 
Sem formatação 
Nome do 
beneficiário final 
8 
dataEmissao 
String 
(date) 
10 
YYYY-MM-DD 
do boleto 
9 
dataVencimento 
String 
(date) 
10 
YYYY-MM-DD 
Data de 
vencimento do 
boleto 
10 
valorNominal 
Bigdecimal 
14,2 
Sem formatação 
Valor nominal 
do boleto 
11 
situação 
String 
 
Sem formatação 
Situação do 
boleto, podendo 
ser: 
 
- EM CARTEIRA 
- EM CARTEIRA 
PIX 
- VENCIDO 
- LIQUIDADO 
- LIQUIDADO 
CARTORIO 
- LIQUIDADO 
REDE 
- LIQUIDADO 
COMPE 
- LIQUIDADO PIX 
- LIQUIDADO 
CHEQUE 
SOLICITACAO 
- PROTESTADO 
- EM CARTORIO 
- NEGATIVADO 
- AGUARDANDO 
ENTRADA EM 
CARTORIO 
- AGUARDANDO 
SUSTACAO DE 
CARTORIO 
- REJEITADO 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 154 
 
 
 
 
Classificação da informação: Uso Irrestrito 
12 
txId 
String 
 
Sem formatação 
Identificador da 
transação Pix 
13 
codigoQrCode 
String 
 
Sem formatação 
QRCODE do 
boleto híbrido 
14 
tipoMulta 
String 
10 
Domínios: VALOR ou 
PERCENTUAL 
Tipo de multa 
 
15 
multa 
Number 
14,2 
Sem formatação 
Percentual de 
multa do boleto 
16 
dataInicioMulta 
number 
10 
YYYY-MM-DD 
Data de início 
para cobrança 
da Multa 
 
17 
abatimento 
Number 
14,2 
Sem formatação 
Valor de 
abatimento 
concedido do 
boleto 
18 
tipoJuros 
String 
14 
Domínios: 
A – VALOR 
B - PERCENTUAL 
Tipo de juros do 
boleto 
19 
tipoJurosPercentual 
String 
6 
Domínios: DIARIO ou 
MENSAL 
Tipo de Juros 
Percentual: 
A - DIARIO 
B - MENSAL 
 
20 
juros 
Number 
14,2 
Sem formatação 
Valor/percentual 
de juros do 
boleto 
21 
dataInicioJuros 
number 
10 
YYYY-MM-DD 
Data de início da 
cobrança de 
Juros 
 
22 
diasProtesto 
Integer 
2 
Sem formatação 
Quantidade de 
dias para 
protesto 
automático do 
boleto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 155 
 
 
 
 
Classificação da informação: Uso Irrestrito 
23 
idTituloEmpresa 
String 
25 
Sem formatação 
idTituloEmpresa 
enviado no 
momento do 
título. (Obs: Só 
será retornado 
se o título 
possuir essa 
informação). 
24 
validadeAPosVencimento 
Integer 
4 
Sem formatação 
Validade após 
vencimento 
25 
diasNegativacao 
Integer 
2 
Sem formatação 
Dias para 
negativação do 
boleto 
26 
tipoDesconto 
String 
14 
Domínios: 
 
A – VALOR 
B - PERCENTUAL 
Tipo de 
desconto do 
boleto, podendo 
ser: 
 
A – VALOR 
B - PERCENTUAL 
27 
descontoAntecipacao 
Number 
14,2 
Sem formatação 
Valor do 
desconto 
antecipado do 
boleto 
28 
descontos 
 
(Lista com até 3 
descontos) 
 
Obs: Caso não exista 
desconto cadastrado, a 
lista retorna vazia: 
 
"descontos": [] 
 
numeroOrdem Integer 
 
1 
 
Domínios: 
 
1 
2 
3 
 
 Número da 
ordem, podendo 
ser: 
 
1- Desconto 1 
2- Desconto 2 
3- Desconto 3 
 
 
valorDesconto Bigdecimal 
14,2 
  "valorDesconto": 0.0 
Valor/percentual 
de desconto 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 156 
 
 
 
 
Classificação da informação: Uso Irrestrito 
dataLimite 
String(date) 
 
10 
 "dataLimite": "YYYY-
MM-DD" 
Data limite do 
desconto 
 
 
 
 
29 
dadosLiquidacao 
 
(Grupo que retorna os 
valores de liquidação do 
boleto) 
 
OBS: Esse grupo só será 
exibido caso o boleto 
esteja liquidado.  
data 
String(date)  
YYYY-MM-
DD'T':HH:mm:ss.SSS'Z' 
Data e hora da 
liquidação do 
boleto 
valor 
Bigdecimal 
14,2 
Sem formatação 
Valor da 
liquidação do 
boleto 
multa 
Bigdecimal 
14,2 
Sem formtação 
Valor da multa 
cobrado na 
liquidação 
abatimento 
Bigdecimal 
14,2 
Sem formatação 
Valor do 
abatimento 
concedido na 
liquidação 
juros 
Bigdecimal 
14,2 
Sem formatação 
Valor de juros 
cobrado na 
liquidação 
desconto 
Bigdecimal 
14,2 
Sem formatação 
Valor do 
desconto 
concedido na 
liquidação 
30 
dataMovimento 
 
(Campo retorna Data 
do Movimento que foi 
efetivada liquidação) 
String (data) 
10 
"YYYY-MM-DD" 
Data do 
Movimento  
 
OBS: só será 
exibida caso 
enviado o 
headerParam 
data-movimento 
= true. 
31 
dataPrevisaoPagamento 
 
(Campo retorna data do 
crédito do boleto na 
conta do beneficiário) 
String (data) 
10 
"YYYY-MM-DD" 
Data de Previsão 
do crédito na 
conta do 
beneficiário de 
cobrança.  
 
OBS. Só será 
exibido para 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 157 
 
 
 
 
Classificação da informação: Uso Irrestrito 
boletos 
liquidados. 
 
 
 
 
RETORNO (Response): 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso 
 
 
 
 
 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 158 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_NOT_FOUND (404) 
Titulo não 
encontrado 
Parâmetro: 
nossoNumero 
não existe resultado para a 
HTTP_BAD_REQUEST (400) 
O campo nosso 
numero deve ter 
apenas 9 (nove) 
caracteres 
numéricos. 
Parâmetro: 
nossoNumero 
parâmetro foi preenchido 
com menos ou mais de 9 
caracteres. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
 
REQUEST – GET:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto”,  “codigoBeneficiario” e “nossoNumero”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
Versão 1 - “v1” 
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos 
HEADERS: 
Authorization 
x-api-key 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 159 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Content-Type: application/json 
Cooperativa 
posto 
 
PARAMS: 
codigoBeneficiario 
nossoNumero 
 
Versão 2 - “v2” (Não possui sandbox) 
https://api-parceiro.sicredi.com.br/cobranca/boleto/v2/boletos 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
data-movimento 
 
PARAMS: 
codigoBeneficiario 
nossoNumero 
 
RESPONSE BODY:  
{ 
            "linhaDigitavel": "74891121150039736789903123451001187340000000050", 
            "codigoBarras": "74897937700000099891122224595067890312345109", 
            "carteira": "SIMPLES", 
            "seuNumero": "TESTE", 
            "nossoNumero": "211001292", 
            "pagador": { 
                "codigo": "XXXXX", 
                "documento": "000000000", 
                "nome": "TESTE COBRANCA" 
            }, 
            "beneficiarioFinal": { 
                "codigo": "000", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 160 
 
 
 
 
Classificação da informação: Uso Irrestrito 
                "documento": "00000000000", 
                "nome": "COBRANCA TESTE" 
            }, 
            "dataEmissao": "2022-08-25", 
            "dataVencimento": "2022-09-23", 
            "valorNominal": 1, 
            "situacao": "EM CARTEIRA PIX", 
            "txId": "79031878967e4032a89c59eb3f232cda", 
            "codigoQrCode": " 00020126930014br.gov.bcb.pix2571pix-qrcode-
h.sicredi.com.br/qr/v2/cobv/528520acdd5f4740b63b9b643ca2bcf99999999999999999999BR5903PIX
6006Cidade62070503***630441AC", 
 "tipoMulta": "PERCENTUAL", 
            "multa": 0, 
 "dataInicioMulta":"2025-11-26", 
            "abatimento": 0, 
            "tipoJuros": "A - VALOR", 
  "tipoJurosPercentual": "DIARIO", 
            "juros": 0, 
 "dataInicioJuros":"2025-11-26", 
            "diasProtesto": 0, 
            "validadeAposVencimento": 1, 
            "diasNegativacao": 0, 
            "tipoDesconto": "A - VALOR", 
            "descontoAntecipacao": 0, 
            "descontos": [ 
{ 
                    "numeroOrdem": 1, 
                    "valorDesconto": 10, 
                    "dataLimite": "2022-09-03" 
                 
}, 
                 
{ 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 161 
 
 
 
 
Classificação da informação: Uso Irrestrito 
                                "numeroOrdem": 2, 
                                "valorDesconto": 8, 
                                "dataLimite": "2022-09-05" 
                
 }, 
                 
{ 
                    "numeroOrdem": 3, 
                    "valorDesconto": 5, 
                    "dataLimite": "2022-09-07" 
                } 
] 
        } 
    ], 
"dataMovimento": "2024-01-25",  -> Essa informação será apresentada somente na v2 
"boletoComSplit": "NAO" 
} 
Execução (via ferramenta Postman) 
 
Headers:  
Chamada endpoint v1: 
 
Chamada endpoint v2: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 162 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Params:  
 
 
Cenário Positivo:  
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 163 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
Cenário Negativo: 400 – BAD_REQUEST 
 
boletos já liquidados, através de uma data específica. O formato de entrada e saída é JSON, considerando 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 164 
 
 
 
 
Classificação da informação: Uso Irrestrito 
em milissegundos. 
 
▪ OBS: Quando os boletos são pagos através do PIX nos finais de semana, o 
valor é creditado no mesmo dia da liquidação. No entanto, a informação 
da data de liquidação será disponibilizada com data do dia útil seguinte. 
data do dia útil seguinte à liquidação PIX.  
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
Header  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   
authorization  
String   
Header   
1413 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/
x-www-
form-
urlencoded 
Header 
Sem formatação Tipo conteúdo 
Não 
obrigatório 
4   
cooperativa   
String   
Header   
4 
cooperativa do 
beneficiário  
Obrigatório  
5 
posto 
String 
Header 
2 
agência do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Param 
5 
beneficiário 
Obrigatório 
7 
dia 
String 
Param 
10 
DD/MM/YYYY 
Data em que o 
boleto foi 
liquidado 
Obrigatório 
8 
cpfCnpjBeneficiario
Final 
String 
Param 
14 
Sem formatação CPF ou CNPJ do 
beneficiário final 
Opcional 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 165 
 
 
 
 
Classificação da informação: Uso Irrestrito 
9 
pagina 
Integer 
Param 
2 
Sem formatação Número da 
página da 
Opcional 
 
Saída: 
Ord Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
items 
cooperativa 
String 
4 
Sem 
formatação  
Cooperativa do beneficiário 
do boleto 
2 
codigoBeneficiario 
String 
5 
Sem 
formatação 
boleto 
3 
cooperativaPostoBeneficiario String 
6 
Sem 
formatação 
posto do beneficiário 
4 
nossoNumero 
String 
9 
Sem 
formatação 
Nosso Número 
5 
seuNumero 
String 
10 
Sem 
formatação 
Seu Número do boleto 
6 
tipoCarteira 
String 
20 
Sem 
formatação 
Tipo de carteira, podendo 
ser: 
 
- CARTEIRA_SIMPLES 
- CARTEIRA_ CAUCIONADA 
- CARTEIRA_DESCONTADA 
- CARTEIRA_VINCULADA 
7 
dataPagamento 
String 
10 
YYYY-MM-DD 
Data da liquidação do 
boleto 
8 
valor 
Number 14,2 
Sem 
formatação 
Valor nominal do boleto 
9 
valorLiquidado 
Number 14,2 
Sem 
formatação 
Valor da liquidação do 
boleto 
10 
jurosLiquido 
Number 14,2 
Sem 
formatação 
Valor de juros do boleto 
liquidado 
11 
descontoLiquido 
Number 14,2 
Sem 
formatação 
Valor de desconto do 
boleto liquidado 
12 
multaLiquida 
Number 14,2 
Sem 
formatação 
Valor de multa do boleto 
liquidado 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 166 
 
 
 
 
Classificação da informação: Uso Irrestrito 
13 
abatimentoLiquido 
Number 14,2 
Sem 
formatação 
Valor de abatimento do 
boleto liquidado 
14 
tipoLiquidacao 
String 
23 
Sem 
formatação 
Tipo da liquidação, 
podendo ser: 
 
- AVISO DE PAGAMENTO 
REDE 
- AVISO DE PAGAMENTO 
COMPE 
- REDE 
- COMPE 
- PIX 
15 
hasNext 
String 
5 
Sem 
formatação 
Esse campo indica se 
existem mais páginas ou 
não, podendo ser: 
 
- false (indica que não 
existem mais páginas) 
- true (existem mais 
páginas) 
 
OBS: Cada página retorna 
500 registros. 
 
RETORNO (Response): 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso 
 
 
FALHAS: 
Mensagem  
Parâmetros de entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório 
não informado ou 
inválido.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 167 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  Parâmetro:  
Authorization  
parâmetro obrigatório 
não foi  informado ou 
inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente 
do beneficiário contido 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
a cooperativa informada 
é diferente da 
cooperativa contida no 
(authorization). 
HTTP_BAD_REQUEST (400) 
O dia de pesquisa 
deve ter 10 
caracteres e seguir 
o padrão: 
DD/MM/YYYY. 
Parâmetro: 
dia 
a data de pesquisa está 
inválida. 
HTTP_BAD_REQUEST (400) 
BAD_REQUEST 
Parâmetro: 
dia 
a data de pesquisa não 
foi informada. 
HTTP_BAD_REQUEST (400) 
do beneficiário 
deve ter 5 (cinco) 
caracteres 
numéricos. 
Parâmetro: 
codigoBeneficiario 
informado está inválido 
ou não foi informado. 
HTTP_BAD_REQUEST (400) 
Documento do 
beneficiário final 
inválido. 
Parâmetro: 
cpfCnpjBeneficiarioFinal
o cpf/cnpj do 
beneficiário final 
informado é inválido. 
HTTP_TOO_MANY_REQUESTS 
(429) 
Too many 
requests 
Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 168 
 
 
 
 
Classificação da informação: Uso Irrestrito 
REQUEST – GET:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/liquidados/dia 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/liquidados/dia 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/x-www-form-urlencoded 
Cooperativa 
Posto 
 
 
PARAMS: 
codigoBeneficiario 
dia 
cpfCnpjBeneficiarioFinal 
pagina 
 
RESPONSE BODY:  
{ 
    "items": [ 
        { 
            "cooperativa": "6789", 
            "codigoBeneficiario": "12345", 
            "cooperativaPostoBeneficiario": "678903", 
            "nossoNumero": "000000000", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 169 
 
 
 
 
Classificação da informação: Uso Irrestrito 
            "seuNumero": "TESTE", 
            "tipoCarteira": "CARTEIRA_NORMAL", 
            "dataPagamento": "2022-11-14", 
            "valor": 0.5, 
            "valorLiquidado": 0.5, 
            "jurosLiquido": 0, 
            "descontoLiquido": 0, 
            "multaLiquida": 0, 
            "abatimentoLiquido": 0, 
            "tipoLiquidacao": "REDE" 
        } 
    ], 
    "hasNext": false 
} 
 
 
 
 
 
Execução (via ferramenta Postman) 
 
Headers:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 170 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Params:  
 
Cenário Positivo:  
 
 
 
Cenário Negativo: 401 – UNAUTHORIZED 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 171 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Cenário Negativo: 400 – BAD_REQUEST 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 172 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
“idEmpresa” ou “seuNumero” 
A operação GET “Verifica se título já cadastrado ‘idEmpresa’ ou ‘seuNumero’” pode ser utilizada 
com o objetivo de verificar se já existe um título cadastrado na base Sicredi com aquela informação de 
de entrada e saída é JSON onde caso exista registros, eles serão retornados em uma lista que irá conter 
os dados do título pesquisado de acordo com o filtro utilizado. Considerando que a saída sempre é 
utilizado no Response é Unicode UTF-8. 
 
Entrada: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetr
o 
 
Tamanho 
Formatação 
Descrição 
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 173 
 
 
 
 
Classificação da informação: Uso Irrestrito 
1 
x-api-key 
String 
Header 
36 
UUID 
fornecido pelo 
Sicredi 
Obrigatório 
2 
Authorization 
String 
Header 
1413 
obtido na 
Obrigatório 
3 
Content-Type 
application/
x-www-
form-
urlencoded 
Header 
Sem formatação Tipo conteúdo 
Obrigatório 
4 
posto 
String 
Header 
2 
do beneficiário 
Obrigatório 
5 
cooperativa 
String 
Header 
4 
cooperativa do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Param 
5 
beneficiário 
Obrigatório 
7 
seuNumero 
String 
Param 
10 
Sem formatação “seuNumero” 
informado no 
do título 
Opcional 
8 
idTituloEmpresa 
String 
Param 
25 
Sem formatação “idTituloEmpres
a” informado no 
do título 
Opcional 
 
Saída: 
Ord Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
linhaDigitavel 
String 
47 
Sem formatação  
Linha digitável do 
boleto 
2 
codigoBarras 
String 
44 
Sem formatação 
boleto 
3 
qrCode 
String 
201 
Sem formatação 
QRCode PIX em caso 
de títulos híbridos. 
Se o título for 
normal não será 
retornado essa 
informação. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 174 
 
 
 
 
Classificação da informação: Uso Irrestrito 
4 
seuNumero 
String  
10 
Sem formatação 
Seu Número do 
título cadastrado. 
5 
idTituloEmpresa 
String  
25 
Sem formatação  
idTituloEmpresa 
caso o título possua 
essa informação. 
6 
valorNominal 
Number 
14,2 
 
Valor nominal do 
título cadastrado. 
7 
Pagador 
(Object) 
documento 
String 
14 
Sem formatação 
Documento do 
pagador 
 
nome 
String 
40 
Sem formatação 
Nome do pagador 
 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso. 
 
 
 
 
FALHAS: 
Mensagem  
Parâmetros de entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório 
não informado ou 
inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  Parâmetro:  
Authorization  
parâmetro obrigatório 
não foi  informado ou 
inválido. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 175 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
beneficiário informado 
é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
quando a cooperativa 
informada é diferente 
da cooperativa contida 
(authorization). 
HTTP_BAD_REQUEST (400) 
O id titulo 
empresa permite 
até 25 caracteres 
Parâmetro: 
idTituloEmpresa 
quando o id informado 
ultrapassa 25 
caracteres. 
HTTP_BAD_REQUEST (400) 
O seu numero do 
boleto deve ter 
até 10 caracteres 
Parâmetro: 
seuNumero 
quando o seu numero 
informado ultrapassa 
10 caracteres. 
HTTP_BAD_REQUEST (400) 
Informe apenas 
uma das duas 
opções: 
seuNumero ou 
idTituloEmpresa 
Parâmetro: 
seuNumero e idTituloEmpresa 
quando os dois 
parâmetros são 
informados 
simultaneamente. 
HTTP_BAD_REQUEST (400) 
Obrigatório 
informar 
seuNumero ou 
idTituloEmpresa. 
Parâmetro: 
seuNumero e idTituloEmpresa 
quando nenhum dos 
dois parâmetros é 
informado. 
HTTP_BAD_REQUEST (404) 
Título não 
encontrado 
Parâmetro: 
seuNumero e idTituloEmpresa 
quando nenhum título 
é encontrado para 
aquele seuNumero ou 
idTituloEmpresa 
HTTP_TOO_MANY_REQUESTS 
(429) 
Too many 
requests 
Não se aplica 
quando são enviadas 
muitas requisições em 
um curto espaço de 
tempo. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 176 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/cadastrados 
HEADERS: 
Authorization 
x-api-key 
Content-Type application/json 
cooperativa 
posto 
 
PARAMS: 
codigoBeneficiario 
idTituloEmpresa 
seuNumero 
 
RESPONSE BODY: 
 
[ 
    { 
        "codigoBarras": "74892976100000000000000000009999990800000004", 
        "linhaDigitavel": "74800000000001070000000000000000000009999900200", 
        "qrCode": "00020126910014br.gov.bcb.pix2569pix-
qrcode.sicredi.com.br/qr/v2/cobv/xxxxxxxxxxxxxx996d58209b00000a65204000050000000000BR5903P
IX6006Cidade62070503***6304CC72", 
        "seuNumero": "TESTE", 
        "idTituloEmpresa": "9999-TESTE-89ABC", 
        "valorNominal": 2, 
        "pagador": { 
            "documento": "99999900012", 
            "nome": "TESTE PAGADOR" 
        } 
    } 
] 
 
 
Execução (via ferramenta Postman) 
HEADERS: 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 177 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
PARAMS: 
 
 
 
 
▪ 
Cenário Positivo:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 178 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
(Francesinha) 
movimentações financeiras de crédito e/ou débito de uma determinada data. O formato de entrada e 
saída é JSON onde os registros retornados estão paginados de acordo com a quantidade total de 
movimentações financeiras da data informada, sendo apresentados em 1000 registros por página 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 179 
 
 
 
 
Classificação da informação: Uso Irrestrito 
um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão o recurso 
▪ 
para um retorno de no máximo 1 mil registros por data de movimento. Essa 
parametrização pode aumentar conforme necessidade. 
 
Entrada: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetr
o 
 
Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key 
String 
Header 
36 
UUID 
fornecido pelo 
Sicredi 
Obrigatório 
2 
Authorization 
String 
Header 
1413 
obtido na 
Obrigatório 
3 
Content-Type 
application/
x-www-
form-
urlencoded 
Header 
Sem formatação Tipo conteúdo 
Obrigatório 
4 
beneficiario 
String 
Param 
5 
beneficiário 
Obrigatório 
5 
agencia 
String 
Param 
4 
agência do 
beneficiário 
Obrigatório 
6 
dataLancamento 
String 
Param 
10 
DD/MM/YYYY 
beneficiário 
Obrigatório 
7 
tipoMovimento 
String 
ENUM 
- CREDITO 
- DEBITO 
- AMBOS 
Tipo de 
movimento 
(CREDITO e/ou 
DEBITO)  a ser 
retornado 
Obrigatório 
8 
pagina 
Integer 
Param 
0 
Sem formatação Número da 
página da 
Opcional 
 
Saída: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 180 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Ord 
Nome 
Tipo 
Tamanho 
Formatação 
Descrição 
1  
resultado 
agencia 
String 
4 
Sem formatação  
Agência do associado. 
2 
posto 
String 
2 
Sem formatação 
beneficiário. 
3 
beneficiario 
String 
5 
Sem formatação 
associado. 
4 
nossoNumero 
String 
9 
Sem formatação 
Nosso Número 
5 
seuNumero 
String 
10 
Sem formatação 
Seu Número do boleto 
6 
nomePagador 
String 
40 
Sem formatação 
Nome do pagador 
referente a liquidação. 
7 
identPagador 
String 
14 
Sem formatação 
Documento de 
identificação do pagador 
(CPF/CNPJ) 
8 
datamovimento 
String 
10 
YYYY/MM/DD 
Data da movimentação 
financeira 
9 
dataLancamento 
String 
10 
YYYY/MM/DD 
Data do lançamento 
financeiro 
10 
valorNominal 
Number 
14,2 
00.0 
Valor nominal da 
liquidação 
11 
valorAbatimento 
Number 
14,2 
00.0 | 0.00 
Valor de abatimento 
12 
valorDesconto 
Number 
14,2 
00.0 | 0.00 
Valor de desconto 
13 
valorJuros 
Number 
14,2 
00.00 | 0.00 
Valor de juros 
14 
valorMulta 
Number 
14,2 
00.00 | 0.00 
Valor de multa 
15 
 
valorMovimento 
Number 
14,2 
00.0 | 0.00 
Valor da movimentação 
16 
 
tipoMovimento 
String 
CREDITO 
e/ou 
DEBITO 
Sem formatação 
Tipo de movimentação 
financeira. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 181 
 
 
 
 
Classificação da informação: Uso Irrestrito 
17 
 
descMovimento 
String 
 
Sem formatação 
Descrição do movimento 
realizado 
18 
 
carteira 
String 
 
Sem formatação 
Tipo de carteira, 
podendo ser: 
 
A – SIMPLES 
B – CAUCIONADA 
C – DESCONTADA 
D – VINCULADA 
19 
 
agDistribuicao 
String 
4 
Sem formatação 
Agência da conta de 
distribuição de valores 
do associado. 
20 
 
contaDistribuicao 
String 
6 
Sem formatação 
Conta de distribuição de 
valores do associado. 
21 
 
percDistribuicao 
Integer 
 
100 | 50 | 75  
Percentual de 
distribuição de valores. 
22 
 
valorDistribuicao 
Number 
14,2 
00.0 | 0.00 
Valor distribuição de 
crédito. 
23 
 
codTxId 
String 
 
 
TXID do título híbrido. 
Esse campo só é 
retornado em títulos 
que possuem QRCode 
(Boleto Híbrido)  
 
24 
total 
Long 
 
13 
Indica a quantidade 
total de registros 
retornados na pesquisa. 
25 
pagina 
Long 
 
0 
Indica a página atual da 
pesquisa. 
25.2 
totalPaginas 
Integer 
 
1 
Indica o número de 
páginas. 
25.3 
quantidadePorPagina 
Long 
300 
300 
Indica a quantidade de 
registros por página. 
 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso. 
 
FALHAS: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 182 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Mensagem  
Parâmetros de entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório 
não informado ou 
inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  Parâmetro:  
Authorization  
parâmetro obrigatório 
não foi  informado ou 
inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
beneficiário informado 
é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
quando a cooperativa 
informada é diferente 
da cooperativa contida 
(authorization). 
HTTP_BAD_REQUEST (400) 
O dia de pesquisa 
deve ter 10 
caracteres e seguir 
o padrão: 
DD/MM/YYYY. 
Parâmetro: 
dia 
quando a data de 
pesquisa está inválida. 
HTTP_BAD_REQUEST (400) 
BAD_REQUEST 
Parâmetro: 
dia 
quando a data de 
pesquisa não foi 
informada. 
HTTP_BAD_REQUEST (400) 
do beneficiário 
deve ter 5 (cinco) 
caracteres 
numéricos. 
Parâmetro: 
codigoBeneficiario 
beneficiário informado 
está inválido ou não foi 
informado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 183 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
Documento do 
beneficiário final 
inválido. 
Parâmetro: 
cpfCnpjBeneficiarioFinal 
quando o cpf/cnpj do 
beneficiário final 
informado é inválido. 
HTTP_TOO_MANY_REQUESTS 
(429) 
Too many 
requests 
Não se aplica 
quando são enviadas 
muitas requisições em 
um curto espaço de 
tempo. 
 
REQUEST – GET:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/v1/cobranca-financeiro/movimentacoes/ 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“codigoBeneficiario”, “posto”: 
codigoBeneficiario: 12345 
cooperativa: 6789 
posto: 03 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/v1/cobranca-financeiro/movimentacoes/ 
 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/x-www-form-urlencoded 
 
PARAMS: 
pagina 
codigoBeneficiario 
cooperativa 
posto 
dataLancamento 
tipoMovimento 
posto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 184 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
RESPONSE BODY: 
 
{ 
  "resultado": [ 
    { 
      "agencia": "9999", 
      "posto": "00", 
      "beneficiario": "99999", 
      "nossoNumero": "60000999", 
      "seuNumero": "TESTE", 
      "nomePagador": "MOCK TESTE", 
      "identPagador": "99999999999", 
      "dataMovimento": "2023-09-25", 
      "dataLancamento": "2023-09-26", 
      "valorNominal": 0.01, 
      "valorAbatimento": 0, 
      "valorDesconto": 0, 
      "valorJuros": 0, 
      "valorMulta": 0, 
      "valorMovimento": 0.01, 
      "tipoMovimento": "CREDITO", 
      "descMovimento": "LIQUIDACAO REDE", 
      "carteira": "SIMPLES", 
      "agDistribuicao": "9999", 
      "contaDistribuicao": "999999", 
      "percDistribuicao": 100, 
      "valorDistribuicao": 0.01, 
      "codTxId": "99999999999a1a11a6aaa11a1aaa1aa" – Presente somente se for título híbrido 
    } 
  ], 
  "total": 1, 
  "pagina": 0, 
  "totalPaginas": 1, 
  "quantidadePorPagina": 1000 
} 
 
 
Execução (via ferramenta Postman) 
HEADERS: 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 185 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
PARAMS: 
 
 
 
 
 
 
 
 
 
 
 
 
 
▪ 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 186 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
▪ 
Cenário Negativo: 401 – UNAUTHORIZED 
 
▪ 
Cenário Negativo: 400 – BAD_REQUEST 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 187 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
▪ 
Cenário Negativo: 400 – BAD_REQUEST 
 
Crédito 
O formato de entrada e saída é JSON, considerando que a saída sempre é composta da entidade a ser 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 188 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
Header  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   
authorization  
String   
Header   
1413 
obtido na 
Obrigatório 
 
3 
Content-Type 
application/
json 
Header 
Sem formatação Tipo conteúdo 
Obrigatório 
4   
cooperativa   
String   
Header   
4 
cooperativa do 
beneficiário  
Obrigatório  
5 
Posto 
String 
Header 
2 
agência do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Param 
5 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Param 
9 
Sem formatação Nosso Número Obrigatório 
8 
retornaDadosSplit String 
Param 
3 
Domínios: 
- SIM 
- NÃO 
Campo que 
indica se os 
dados da 
distribuição de 
crédito 
retornarão na 
Opcional 
 
Saída: 
Ord Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
linhaDigitavel 
String 
47 
Sem formatação  
Linha digitável do 
boleto 
2 
codigoBarras 
String 
44 
Sem formatação 
do boleto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 189 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
carteira 
String 
 
Sem formatação 
Tipo de carteira, 
podendo ser: 
 
A – SIMPLES 
B – CAUCIONADA 
C – DESCONTADA 
D – VINCULADA 
4 
seuNumero 
String  
10 
Sem formatação 
Seu Número 
5 
nossoNumero 
String  
9 
Sem formatação  
Nosso Número 
6 
Pagador 
 
(Grupo com os 
dados do 
pagador) 
codigo 
String 
5 
Sem formatação 
Codigo do 
pagador 
 
documento 
String 
14 
Sem formatação 
Documento do 
pagador 
 
nome 
String 
40 
Sem formatação 
Nome do pagador 
7 
beneficiarioFinal 
 
(Grupo com os 
dados do 
beneficiário 
final) 
 
OBS: Caso não 
exista 
beneficiário final 
vinculado ao 
boleto, o grupo 
não será 
exibido. 
codigo 
String 
3 
Sem formatação 
beneficiário final 
 
 
documento 
String 
14 
Sem formatação 
Documento do 
beneficiário final 
 
nome 
String 
40 
Sem formatação 
Nome do 
beneficiário final 
8 
dataEmissao 
String 
(date) 
10 
YYYY-MM-DD 
do boleto 
9 
dataVencimento 
String 
(date) 
10 
YYYY-MM-DD 
Data de 
vencimento do 
boleto 
10 
valorNominal 
Bigdecimal 
14,2 
Sem formatação 
Valor nominal do 
boleto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 190 
 
 
 
 
Classificação da informação: Uso Irrestrito 
11 
situação 
String 
 
Sem formatação 
Situação do 
boleto, podendo 
ser: 
 
- EM CARTEIRA 
- EM CARTEIRA 
PIX 
- VENCIDO 
- LIQUIDADO 
- LIQUIDADO 
CARTORIO 
- LIQUIDADO 
REDE 
- LIQUIDADO 
COMPE 
- LIQUIDADO PIX 
- LIQUIDADO 
CHEQUE 
SOLICITACAO 
- PROTESTADO 
- EM CARTORIO 
- NEGATIVADO 
- AGUARDANDO 
ENTRADA EM 
CARTORIO 
- AGUARDANDO 
SUSTACAO DE 
CARTORIO 
- REJEITADO 
12 
txId 
String 
 
Sem formatação 
Identificador da 
transação Pix 
13 
codigoQrCode 
String 
 
Sem formatação 
QRCODE do 
boleto híbrido 
14 
multa 
Number 
14,2 
Sem formatação 
Percentual de 
multa do boleto 
15 
abatimento 
Number 
14,2 
Sem formatação 
Valor de 
abatimento 
concedido do 
boleto 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 191 
 
 
 
 
Classificação da informação: Uso Irrestrito 
16 
tipoJuros 
String 
14 
Domínios: 
A - VALOR 
B - PERCENTUAL 
Tipo de juros do 
boleto 
17 
juros 
Number 
14,2 
Sem formatação 
Valor/percentual 
de juros do 
boleto 
18 
diasProtesto 
Integer 
2 
Sem formatação 
Quantidade de 
dias para protesto 
automático do 
boleto 
19 
validadeAPosVencimento 
Integer 
4 
Sem formatação 
Validade após 
vencimento 
20 
diasNegativacao 
Integer 
2 
Sem formatação 
Dias para 
negativação do 
boleto 
21 
tipoDesconto 
String 
14 
Domínios: 
 
A - VALOR 
B - PERCENTUAL 
Tipo de desconto 
do boleto, 
podendo ser: 
 
A - VALOR 
B - PERCENTUAL 
22 
descontoAntecipacao 
Number 
14,2 
Sem formatação 
Valor do desconto 
antecipado do 
boleto 
23 
descontos 
 
(Lista com até 3 
descontos) 
 
Obs: Caso não 
exista desconto 
cadastrado, a 
numeroOrdem 
Integer 
 
1 
 
Domínios: 
 
1 
2 
3 
 
 Número da 
ordem, podendo 
ser: 
 
1- Desconto 1 
2- Desconto 2 
3- Desconto 3 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 192 
 
 
 
 
Classificação da informação: Uso Irrestrito 
lista retorna 
vazia: 
 
"descontos": [] 
 
valorDesconto 
Bigdecimal 
14,2 
  "valorDesconto": 0.0 
Valor/percentual 
de desconto 
 
 
dataLimite 
String(date) 
 
10 
 "dataLimite": "YYYY-
MM-DD" 
Data limite do 
desconto 
 
 
 
 
24 
retornaDadosSplit 
String 
3 
Domínios: 
 
SIM 
NAO 
Indica se o boleto 
possui 
distribuição de 
crédito 
24 
dadosLiquidacao 
 
(Grupo que 
retorna os 
valores de 
liquidação do 
boleto) 
 
OBS: Esse grupo 
só será exibido 
caso o boleto 
esteja liquidado.  
data 
String(date)  
YYYY-MM-
DD'T':HH:mm:ss.SSS'Z' 
Data e hora da 
liquidação do 
boleto 
valor 
Bigdecimal 
14,2 
Sem formatação 
Valor da 
liquidação do 
boleto 
multa 
Bigdecimal 
14,2 
Sem formatação 
Valor da multa 
cobrado na 
liquidação 
abatimento 
Bigdecimal 
14,2 
Sem formatação 
Valor do 
abatimento 
concedido na 
liquidação 
juros 
Bigdecimal 
14,2 
Sem formatação 
Valor de juros 
cobrado na 
liquidação 
desconto 
Bigdecimal 
14,2 
Sem formatação 
Valor do desconto 
concedido na 
liquidação 
25 
dadosSplit 
 
(Grupo com os 
dados da 
 
 
 
 
String 
24 
Sem formatação 
Situação do 
distribuição de 
crédito, podendo 
ser:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 193 
 
 
 
 
Classificação da informação: Uso Irrestrito 
distribuição de 
crédito) 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
- CADASTRADO 
COM SUCESSO 
- AGUARDANDO 
CREDITO 
- ENCAMINHADO 
PARA CREDITO 
 
valorBoleto 
Number 
14,2 
Sem formatação 
Valor do boleto 
 
dataLiquidacaoSplit 
String 
10 
YYYY-MM-DD 
Data de 
liquidação do 
boleto 
 
valorLiquidacaoBoleto 
Number 
14,2 
Sem formatação 
Valor de 
liquidação do 
boleto 
 
tipoTransferencia 
String 
3 
Sem formatação 
Tipo de 
transferência, 
podendo ser: 
 
- TED 
 
regraRateio 
String 
31 
Sem formatação 
Tipo de regra do 
rateio, podendo 
ser: 
 
- VALOR 
COBRADO 
- VALOR DO 
REGISTRO 
- MENOR VALOR: 
REGISTRADO OU 
PAGO 
 
tipoValorRateio 
String 
10 
Sem formatação 
Tipo do valor de 
rateio, podendo 
ser: 
 
- VALOR 
- PERCENTUAL 
 
tipoRepasse 
String 
10 
Sem formatação 
Tipo do repasse, 
podendo ser: 
 
- MANUAL 
- AUTOMATICO 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 194 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
parcelas 
 
(Grupo com os 
dados de cada 
parcela de 
distribuição de 
crédito) 
 
 
 
 
 
 
parcelaRateio 
Integer 
2 
Sem formatação 
Número da 
parcela da 
distribuição de 
crédito 
 
valorPercentualRateio 
Number 
14,2 
Sem formatação 
Valor/Percentual 
da distribuição de 
crédito 
 
codigoBanco 
String 
3 
Sem formatação 
 
codigoAgencia 
String 
4 
Sem formatação 
agência 
 
numeroContaCorrente String 
13 
Sem formatação 
Número da conta 
corrente 
 
numeroCpfCnpj 
String 
14 
Sem formatação 
CPF/CNPJ do 
destinatário 
 
nomeDestinatario 
String 
40 
Sem formatação 
Nome do 
destinatário 
 
floatRepasse 
Integer 
2 
Sem formatação 
Float do repasse 
da distribuição do 
crédito do boleto 
 
String 
36 
Sem formatação 
da parcela da 
distribuição do 
crédito do boleto, 
podendo ser: 
 
1) AGUARDANDO 
LIQUIDACAO 
BOLETO 
2) CANCELADO 
PELO USUARIO 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 195 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3) CANCELADO - 
SPLIT 
4) AGUARDANDO 
PRAZO FLOAT 
5) AGUARDANDO 
LIBERACAO 
BENEFICIARIO 
6) CANCELADO - 
PRAZO 
LIBERACAO 
EXCEDIDO 
7) ENVIADO PARA 
EFETIVACAO 
8) REPASSE 
EFETIVADO 
9) CANCELADO - 
EFETIVAR 
CREDITO 
 
dataPrevistaRepasse 
String 
10 
YYYY-MM-DD 
Data prevista 
para ser realizado 
o repasse 
 
valorRepasse 
Number 
14,2 
Sem formatação 
Valor do repasse 
 
dataEfetivacaoRepasse String 
10 
YYYY-MM-DD 
Data da 
efetivação do 
repasse 
 
informacaoAdicional 
String 
50 
Sem formatação 
Informação 
adicional. Será 
utilizado em 
situações que o 
crédito não foi 
efetivado. 
 
RETORNO (Response): 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 196 
 
 
 
 
Classificação da informação: Uso Irrestrito 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_UNAUTHORIZED (401) 
beneficiário 
diferente do 
beneficiário do 
usuário 
Parâmetro: 
codigoBeneficiario 
informado é diferente do 
beneficiário contido no 
(authorization). 
HTTP_UNAUTHORIZED (401) 
Cooperativa 
diferente da 
cooperativa do 
usuário 
Parâmetro: 
Cooperativa 
cooperativa informada é 
diferente da cooperativa 
(authorization). 
HTTP_NOT_FOUND (404) 
Titulo não 
encontrado 
Parâmetro: 
nossoNumero 
não existe resultado para a 
HTTP_BAD_REQUEST (400) 
O campo nosso 
numero deve ter 
apenas 9 (nove) 
caracteres 
numéricos. 
Parâmetro: 
nossoNumero 
parâmetro foi preenchido 
com menos ou mais de 9 
caracteres. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 197 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
O campo 
retornaDadosSplit 
deve ser SIM ou 
NAO. 
Parâmetro: 
retornaDadosSplit 
parâmetro ser preenchido 
com dados inválidos. 
 
REQUEST – GET:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v2/boletos 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto”,  “codigoBeneficiario” e “nossoNumero”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v2/boletos 
 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
 
PARAMS: 
codigoBeneficiario 
nossoNumero 
retornaDadosSplit 
 
RESPONSE BODY:  
{ 
  "linhaDigitavel": "74891160090066690434710123451009194270000100000", 
  "codigoBarras": "74891942700001000001160000666904341012345100", 
  "carteira": "SIMPLES", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 198 
 
 
 
 
Classificação da informação: Uso Irrestrito 
  "seuNumero": "TESTE", 
  "nossoNumero": "666666666", 
  "pagador": { 
    "codigo": "YOHI2", 
    "documento": "85355592000117", 
    "nome": "TESTE SPLIT" 
  }, 
  "beneficiarioFinal": { 
    "codigo": "0EN", 
    "documento": "25140124068", 
    "nome": "TESTE SPLIT" 
  }, 
  "dataEmissao": "2023-05-30", 
  "dataVencimento": "2023-07-30", 
  "valorNominal": 1000, 
  "situacao": "EM CARTEIRA", 
  "multa": 3, 
  "abatimento": 0, 
  "tipoJuros": "A - VALOR", 
  "juros": 5, 
  "diasProtesto": 0, 
  "validadeAposVencimento": 120, 
  "diasNegativacao": 0, 
  "tipoDesconto": "A - VALOR", 
  "descontoAntecipacao": 0, 
  "descontos": [ 
    { 
      "numeroOrdem": 1, 
      "valorDesconto": 10, 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 199 
 
 
 
 
Classificação da informação: Uso Irrestrito 
      "dataLimite": "2023-07-15" 
    }, 
    { 
      "numeroOrdem": 2, 
      "valorDesconto": 7, 
      "dataLimite": "2023-07-20" 
    }, 
    { 
      "numeroOrdem": 3, 
      "valorDesconto": 3, 
      "dataLimite": "2023-07-30" 
    } 
  ], 
  "boletoComSplit": "SIM", 
  "dadosSplit": { 
    "valorBoleto": 1000, 
    "dataLiquidacaoBoleto": "", 
    "valorLiquidacaoBoleto": null, 
    "tipoTransferencia": "TED", 
    "regraRateio": "VALOR_COBRADO", 
    "tipoValorRateio": "PERCENTUAL", 
    "tipoRepasse": "AUTOMATICO", 
    "parcelas": [ 
      { 
        "parcelaRateio": 1, 
        "valorPercentualRateio": 3, 
        "codigoBanco": "237", 
        "codigoAgencia": "0434", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 200 
 
 
 
 
Classificação da informação: Uso Irrestrito 
        "numeroContaCorrente": "2323232323", 
        "numeroCpfCnpj": "02738306004", 
        "nomeDestinatario": "TESTE SPLIT", 
        "floatRepasse": 20, 
        "dataPrevistaRepasse": "", 
        "valorRepasse": null, 
        "dataEfetivacaoRepasse": "" 
      } 
    ] 
  } 
 
Execução (via ferramenta Postman) 
 
Headers:  
 
 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 201 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Params:  
 
Cenário Positivo: 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 202 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 
Cenário Negativo: 400 – BAD_REQUEST 
 
7.23. Cancelar Parcelas de Distribuição de 
Crédito de um Boleto 
A operação PATCH “Cancelar Parcelas de Distribuição de Crédito” é responsável por realizar o 
cancelamento de uma ou mais parcelas da distribuição de crédito de um boleto. O formato de entrada e 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 203 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP dentro de um Response. O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigatório  
2   
authorization  
String   
Header   
1413 
obtido na 
Obrigatório 
 
3 
Content-Type 
applicatio
n/json 
Header 
Sem formatação Tipo conteúdo Obrigatório 
4   
cooperativa   
String   
Header   
4 
cooperativa do 
beneficiário  
Obrigatório  
5 
Posto 
String 
Header 
2 
agência do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Body 
5 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Body 
9 
Sem formatação Nosso Número Obrigatório 
8 
numeroParcelas 
Integer 
Body 
2 
Sem formatação Número das 
parcelas que 
serão 
canceladas. 
Caso não 
informe pelo 
menos uma, 
todas serão 
canceladas. 
Obrigatório 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 204 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
parcelasCanceladas 
Integer 
2 
Sem 
formatação  
Número das parcelas que foram 
canceladas. 
 
RETORNO (Response): 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_BAD_REQUEST (400) 
O campo numero 
parcelas deve 
conter uma lista de 
caracteres 
numéricos. 
numeroParcelas 
parâmetro inválido.  
 
HTTP_NOT_FOUND (404) 
Boleto não 
encontrado. 
Não se aplica 
Boleto não foi encontrado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 205 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
Boleto sem 
parcelas aptas a 
cancelar o split. 
Não se aplica 
O boleto não possui 
parcelas aptas para 
cancelamento. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/split/cancelar-split 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/split/cancelar-split 
 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
 
BODY: 
{ 
  "codigoBeneficiario": "12345", 
  "nossoNumero": " 600001234 ", 
  "numeroParcelas": [ "01", "02", "03" ] 
} 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 206 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Execução (via ferramenta Postman) 
 
Headers:  
 
 
Body:  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 207 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Positivo: Informando as parcelas que seja cancelar.
 
Cenário Positivo: Sem enviar o campo “numeroParcelas”. Portanto, todas serão canceladas. 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 208 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 400 – BAD_REQUEST
 
 
Cenário Negativo: 404 – NOT_FOUND 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 209 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY
 
7.24. Liberar Repasse de Distribuição de 
Crédito de um Boleto 
A operação PATCH “Liberar Repasse de Distribuição de Crédito” é responsável por liberar o repasse 
do crédito das parcelas de um boleto com Split. O formato de entrada e saída é JSON, considerando que 
milissegundos. 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro
  
 
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderPar
am  
36 
UUID  
acesso 
fornecido pelo 
Sicredi  
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 210 
 
 
 
 
Classificação da informação: Uso Irrestrito 
2   
authorization  
String   
Header   
1413 
obtido na 
Obrigatório 
 
3 
Content-Type 
applicatio
n/json 
Header 
Sem formatação Tipo conteúdo Obrigatório 
4   
cooperativa   
String   
Header   
4 
cooperativa do 
beneficiário  
Obrigatório  
5 
Posto 
String 
Header 
2 
agência do 
beneficiário 
Obrigatório 
6 
codigoBeneficiario String 
Body 
5 
beneficiário 
Obrigatório 
7 
nossoNumero 
String 
Body 
9 
Sem formatação Nosso Número Obrigatório 
 
Saída: 
Ord 
Nome 
Tipo 
Tam 
Formatação Descrição 
1  
parcelasRepasse 
Integer 
2 
Sem 
formatação  
Número das parcelas de 
distribuição de crédito que 
foram liberadas. 
 
RETORNO (Response): 
Descrição  
HTTP_OK (200)  
Operação realizada com sucesso 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401) 
Could not find a 
required Access 
request, identified 
by HEADER x-api-
key  
Parâmetro:  
x-api-key  
parâmetro obrigatório não 
informado ou inválido.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 211 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401) 
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetro obrigatório não 
foi  informado ou inválido. 
 
HTTP_BAD_REQUEST (400) 
beneficiario deve 
ter 5 (cinco) 
caracteres 
numéricos. 
parâmetro inválido ou não 
informado. 
HTTP_BAD_REQUEST (400) 
O campo nosso 
numero deve ter 
apenas 9 (nove) 
caracteres 
numéricos. 
nossoNumero 
parâmetro inválido ou não 
informado. 
 
HTTP_NOT_FOUND (404) 
Boleto não 
encontrado. 
Não se aplica 
Boleto não foi encontrado. 
HTTP_UNPROCESSABLE_ENTITY 
(422) 
BOLETO COM 
REPASSE MANUAL 
JÁ LIBERADO. 
Não se aplica 
O boleto não possui 
parcelas de distribuição 
aptas para liberar o 
repasse. 
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica 
são enviadas muitas 
requisições em um curto 
espaço de tempo. 
 
REQUEST – PATCH:  
URL Sandbox (ambiente para homologação):  
https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/split/liberar-repasse 
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “cooperativa”, 
“posto” e “codigoBeneficiario”: 
cooperativa : 6789 
posto: 03 
codigoBeneficiario: 12345 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 212 
 
 
 
 
Classificação da informação: Uso Irrestrito 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/split/liberar-repasse 
 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
Cooperativa 
posto 
 
BODY: 
{ 
  "codigoBeneficiario": "12345", 
  "nossoNumero": " 600001234 ", 
} 
Execução (via ferramenta Postman) 
 
Headers:  
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 213 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Body: 
 
 
Cenário Positivo: 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 214 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Cenário Negativo: 400 – BAD_REQUEST
 
Cenário Negativo: 404 – NOT_FOUND 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 215 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Cenário Negativo: 422 – UNPROCESSABLE_ENTITY 
 
8. Geração Nosso Número 
Se não for enviado o campo “nossoNumero” será retornado um “nossoNumero” gerado 
do boleto, segue a regra para a criação: 
REGRA PARA GERAÇÃO DO NOSSO NÚMERO: 
AABnnnnnD => formato do nossoNumero onde AA é o ano, B é o indicador de geração do nosso número 
Byte, nnnnn é o sequencial e “D” é o dígito verificador. 
Exemplo: 
18 - Ano atual 
2 a 9 - byte de geração 
nnnnn - número sequencial (livre escolha, de 00000 a 99999). 
D - Dígito verificador calculado 
ou seja, a nomenclatura correta é:  18200001-D   
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 216 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Fórmula para cálculo do dígito verificador pelo módulo 11: 
(ccccc), ano atual (yy), indicador de geração do nosso número Byte(b) e o número sequencial do 
beneficiário 
(nnnnn): aaaappcccccyybnnnnn; 
Caso o posto do beneficiário(pp) seja alfanumérico ele deverá ser informado como “00”, 
possibilitando assim o cálculo do DV do Nosso Número. 
 
b) atribuir os pesos (de 2 a 9) correspondentes para cada dígito, começando da direita para a esquerda, 
efetuando cada multiplicação: 
 
c) somar o resultado de cada multiplicação; 
d) dividir o resultado da soma por 11 (onze); 
e) identificar o resto da divisão; 
f) dígito verificador será o resultado da subtração: 11 - resto da divisão. Se o resultado da subtração for 
10 (dez) ou 11 (onze), o dígito verificador será 0 (zero). 
Exemplo: 
cooperativa: 0100 
posto: 02 
cedente: 00248 
ano: 18 
byte da geração: 2 (nosso número gerado pelo cedente) 
número sequencial: 00001 
 
Cálculo para encontrar o DV do “Nosso Número”: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 217 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
Somatório do resultado de cada multiplicação = 142 
 142   /    11 =    12,9091  
   12   x   11 =  132  
142   -  132 =    10  
  11   -    10 =      1   (Caso o resultado seja 10 ou 11, o DV será 0)  
DV = 1 
Exemplo do Nosso Número gerado = 182000011 
 
 
9. Layout do Boleto 
mesmo de acordo com o layout especificado pelo Sicredi, conforme abaixo: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 218 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
Beneficiário: Empresa ou pessoa associada do Sicredi que contratou o produto Cobrança com a 
sua cooperativa. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 219 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
produto Cobrança na sua agência.  
 
Beneficiário final: O beneficiário final (em substituição ao termo SACADOR/AVALISTA), quando 
indicado no boleto, representa o destinatário final do direito que receberá os recursos provenientes 
da liquidação do boleto. 
 
Pagador: É a pessoa física ou jurídica titular da dívida. O banco recebe o pagamento feito pelo 
sacado e transfere o valor pago para a conta do beneficiário. 
 
Número da cooperativa: É o número da cooperativa a qual pertence a conta vinculada ao 
convênio de cobrança da pessoa associada. Esse número é o qual junto com o número de conta o 
associado pode logar no seu internet banking. 
 
Número de posto: É o número da agência a qual pertence a conta vinculada ao convênio de 
Cobrança da pessoa associada. Você pode encontrar essa informação acessando (ou solicitando à 
empresa associada que acesse) o internet banking, no menu “Cobrança”, na opção ‘Cadastrar 
títulos’. Ela encontrará a seguinte informação:  
                                                   
 
 
 
 
 
 
 
Situações dos boletos: o boleto pode ter diversas situações, são elas: 
o 
TODOS 
o 
EM_CARTEIRA: boleto disponível para pagamento, ainda não foi pago (pode ou não estar dentro do 
vencimento). 
o 
LIQUIDADO: boleto já foi pago pelo pagador. 
o 
forma e deseja que o boleto não esteja mais apto para pagamento. 
o 
o 
VENCIDO: Boleto está vencido e não foi pago ainda. 
o 
EM_CARTORIO: Associado solicitou o protesto  
o 
AGUARDANDO_ENTRADA_CARTORIO: Solicitação de protesto feita, mas o boleto ainda não foi 
enviado ao cartório.  
o 
AGUARDANDO_SUSTACAO_CARTORIO: Solicitação para sustar (cancelar) o protesto foi feita, 
aguardando processamento pelo cartório. 
1234 
12346 
46 
NOME DA EMPRESA 
Posto 
Cooperativa 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 220 
 
 
 
 
Classificação da informação: Uso Irrestrito 
o 
identificadas no processo). 
o 
o 
AGUARDANDO_NEGATIVACAO: Solicitação de negativação feita, mas ainda não processada. 
o 
AGUARDANDO_RETIRADA_NEGATIVACAO: Solicitação para retirar a negativação feita, aguardando 
processamento. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 221 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
A integração com o produto o Webhook Cobrança é realizado em duas etapas 
distintas que serão descritas neste manual. 
 
1ª Etapa: Desenvolvimento de uma API para Recebimento de Eventos Webhook: 
É uma API desenvolvida pelo associado, responsável por receber os eventos 
(movimentações) dos títulos via webhook. 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 222 
 
 
 
 
Classificação da informação: Uso Irrestrito 
   2ª Etapa: Contratação do produto via API de contratação informando a URL 
desenvolvida na etapa acima. 
 
 
API associado para Recebimentos de eventos Webhook 
 
12. Apresentação API 
Recebimento de eventos 
       A API de Recebimento de eventos Webhook é uma API que deve ser desenvolvida pelo associado com 
o objetivo de se comunicar e realizar uma integração com a API Webhook do Sicredi, a fim de receber os 
eventos sobre as movimentações que ocorrem em seus títulos de cobrança. 
13. Objetivo 
       Este manual destina-se às pessoas responsáveis pelo desenvolvimento e adaptação dos sistemas 
das empresas associadas ao Sicredi que desejam utilizar o Webhook para receber eventos de 
movimentações refere aos seus títulos de cobrança. O objetivo desse manual é orientar os 
desenvolvedores na construção de uma api para o Recebimentos de eventos que deve estar preparada 
para receber uma requisição POST, realizada por uma API do Sicredi, que irá conter os dados de uma 
determinada movimentação do título (evento). Segue abaixo uma ilustração desse processo: 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 223 
 
 
 
 
Classificação da informação: Uso Irrestrito 
14. Orientações Iniciais 
Para iniciar o processo desenvolvimento de sua API de Recebimentos de eventos Webhook e 
promover a integração sistêmica, você deve seguir as orientações abaixo: 
 
▪ 
O Protocolo de comunicação deve ser HTTPS; 
 
▪ 
Sua API deve utilizar protocolo TLS 1.2 nas requisições; 
 
▪ 
O certificado de sua API não pode ser auto assinado; 
 
▪ 
A API Sicredi possui um timeout padrão de 10 segundos por requisição. Dessa forma, sua 
API de Recebimentos de eventos deverá responder o request em até 10 segundos. Em 
caso de ausência de resposta no tempo estipulado, o evento será marcado como “NÃO 
ENTREGUE”; 
 
▪ 
 
▪ 
Nesse primeiro momento, sua API de Recebimentos de eventos não deve possuir 
 
▪ 
Ao fim do processo de desenvolvimento da API de Recebimentos de eventos, o associado 
deverá informar ao Sicredi o endpoint (URL) de sua API para que a API Sicredi consiga 
iniciar o processo de integração. 
 
 
 
15. Quais as funcionalidades? 
A API de Recebimentos de eventos deverá conter as seguintes funcionalidades: 
▪ 
POST - Recebimento de Eventos: Método que irá ser chamado via API Sicredi para o 
recebimento dos eventos (movimentações). Neste primeiro os eventos disponibilizados 
são: 
o LIQUIDACAO_PIX: Liquidações efetuadas via PIX. 
o LIQUIDACAO_REDE **: Liquidações efetuadas nos canais Sicredi. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 224 
 
 
 
 
Classificação da informação: Uso Irrestrito 
o LIQUIDACAO_COMPE_H5: Liquidações efetuadas em outras instituições (Fora da 
Rede SICREDI) 
o LIQUIDACAO_COMPE_H6: Liquidações com valor superior a 250 mil efetuadas em 
outras instituições (Fora da Rede SICREDI)  
o LIQUIDACAO_COMPE_H8: Recebimento de liquidação fora da Rede SICREDI-
Contingência (Alguma inconsistência de sistema). 
o LIQUIDACAO_CARTORIO: Liquidações efetuadas em cartórios. 
o ESTORNO_LIQUIDACAO_REDE: Liquidações que foram estornadas. 
 
       ** Observação LIQUIDAÇÃO_REDE: Essa liquidação é a única que pode ter 
estorno 
no 
mesmo 
dia. 
Havendo 
estorno 
será 
enviado 
o 
evento 
“ESTORNO_LIQUIDACAO_REDE”. Fica a critério do associado acatar de imediato a 
liquidação ou aguardar o fim do dia para garantir que não ocorreu um estorno.  
 
16. Parâmetros API de 
Recebimentos de eventos 
Para iniciar a integração, a API Sicredi irá encapsular os dados do evento descritos abaixo e irá 
realizar uma chamada, utilizando a URL disponibilizada pelo associado, em sua API de Recebimentos de 
eventos Webhook, que deve estar preparada para receber via POST uma requisição com os seguintes 
parâmetros:  
 
 
 
 
 
2. Exemplo JSON dos parâmetros: 
 
{ 
  "agencia": "9999", 
  "posto": "99", 
  "beneficiario": "12345", 
  "nossoNumero": "221000144", 
  "dataEvento":[2024,3,20,11,40,39,24000000] 
  "movimento": "LIQUIDACAO_PIX", 
  "valorLiquidacao": "101.01", 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 225 
 
 
 
 
Classificação da informação: Uso Irrestrito 
  "valorDesconto": "0", 
  "valorJuros": "0", 
  "valorMulta": "0", 
  "valorAbatimento": "0", 
  “carteira”: “CARTEIRA SIMPLES” 
  "dataPrevisaoPagamento":[2024,3,20] 
  "idEventoWebhook": "N000000000000000000000000000000LIQUIDACAO_PIX" 
} 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
agencia 
String 
4 
Sem formatação 
Cooperativa  
Obrigatório 
2 
posto 
String 
2 
Sem formatação 
Obrigatório  
3 
beneficiario 
String 
5 
Sem formatação 
Convênio de  
Cobrança 
Obrigatório 
4 
nossoNumero 
String 
9 
Sem formatação 
Nosso número do título 
Obrigatório  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 226 
 
 
 
 
Classificação da informação: Uso Irrestrito 
5 
dataEvento 
Array 
(Date) 
40 
[YYYY,MM,DD,00,00,00
.000] 
Data e hora que ocorreu 
o evento 
Obrigatório  
6 
movimento 
String 
753 
Domínios:  
"LIQUIDACAO_PIX", 
"LIQUIDACAO_COMPE_
H5", 
"LIQUIDACAO_COMPE_
H6", 
"LIQUIDACAO_COMPE_
H8", 
* "LIQUIDACAO_REDE",  
"LIQUIDACAO_CARTORI
O" 
"ESTORNO_LIQUIDACA
O_REDE" 
 
Lista de eventos que o 
associado receberá 
informações em caso 
de movimentação. 
 
"LIQUIDACAO_REDE"  
*Obs: Essa liquidação 
é a única que pode ter 
estorno no mesmo 
dia. Havendo estorno 
será enviado o evento 
“ESTORNO_LIQUIDAC
AO 
_REDE”.  
Fica 
a 
critério 
do 
associado acatar de 
imediato a liquidação 
ou aguardar o fim do 
dia para garantir que 
não 
ocorreu 
um 
estorno. 
 
Obrigatório  
7 
valorLiquidacao 
String 
14,2 
 Sem formatação 
Valor da liquidação 
Obrigatório 
8 
valorDesconto 
String 
14,2 
 Sem formatação 
Valor de desconto 
aplicado na liquidação. 
Obrigatório 
9 
valorJuros 
String 
14,2 
    Sem formatação 
Valor de juros aplicado 
na liquidação 
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 227 
 
 
 
 
Classificação da informação: Uso Irrestrito 
10 
valorMulta 
String 
5,2 
    Sem formatação 
Valor de multa aplicado 
na liquidação 
Obrigatório 
11 
valorAbatimento 
String 
14,2 
    Sem formatação 
Valor de abatimento 
aplicado na liquidação 
Obrigatório 
12 
carteira 
String 
30 
Domínios: 
CARTEIRA SIMPLES  
CARTEIRA CAUCIONADA  
CARTEIRA DESCONTADA 
CARTEIRA VINCULADA 
Tipo de carteira do 
título  
Opcional 
13 
dataPrevisaoPagam
ento 
Array 
(Date) 
40 
[YYYY,MM,DD] 
Data de prevista para o 
crédito da liquidação 
Opcional  
14 
idEventoWebhook 
String 
50 
    Sem formatação 
único de cada evento. 
Cada evento possui um 
identificador único, 
representado por esse 
parâmetro. 
Obrigatório 
15 
idTituloEmpresa 
String 
25 
    Sem formatação 
ID de controle do 
associado (semelhante 
ao seuNumero) 
informado no momento 
(item 32, tópico 
 
 
(Obs: Só será enviada 
essa informação no 
evento de liquidação se 
o título possuir essa 
informação e o 
associado tiver optado 
por receber essa 
Opcional 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 228 
 
 
 
 
Classificação da informação: Uso Irrestrito 
informação no 
momento da 
RETORNO (Response): 
 
API de Contratação Webhook 
 
17. Apresentação API de 
Contratação Webhook 
 
       A API de Contrato Webhook realiza a criação de um contrato para os beneficiários que desejam 
utilizar este produto, que tem como finalidade o recebimento de eventos sobre as movimentações que 
ocorrem em seus títulos de cobrança. O Webhook é um recurso que possibilita o envio de dados em 
tempo real entre dois sistemas. Através do Webhook, diferentes sistemas podem ser integrados para que 
os eventos entre produtor e cliente permaneçam sincronizados. 
18. Para quem? 
 
       São variados os tipos de negócios que podem empregar este tipo de recebimento. Negócios 
representados por uma Pessoa Jurídica, seja do ramo da indústria, comércio, prestação de serviço, 
agronegócio, Governo*, não importando esferas municipais, estaduais ou federal, da administração 
direta ou indireta, ou Pessoa Física, profissional liberal, produtor rural ou autônomo, que precisem 
receber recursos oriundos de uma oferta, proposta, venda ou serviço prestado. 
 
Descrição 
HTTP_OK (200)  
                          Operação realizada com sucesso  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 229 
 
 
 
 
Classificação da informação: Uso Irrestrito 
19. Objetivo 
 
       Este manual destina-se às pessoas responsáveis pelo desenvolvimento e adaptação dos sistemas 
das empresas associadas ao Sicredi que desejam realizar contratação do Webhook e receber os eventos 
de movimentações dos títulos através da integração via API.  
20. Orientações Iniciais 
Para iniciar o processo de contratação do Webhook, o associado deve possuir um convênio ATIVO com 
o produto Cobrança do Sicredi e possuir a modalidade Cobrança Online. 
 
Logo, para promover a integração sistêmica de registro on-line de Boletos a empresa ou pessoa associada 
inicialmente precisa:  
 
▪ 
Ter contratado o produto Cobrança através da sua cooperativa  
▪ 
Ter optado pela modalidade API (Cobrança Online); 
▪ 
Ter o termo de contratação/adesão assinado; 
21. Quais as funcionalidades? 
A API de Contratação Webhook contém as seguintes funcionalidades: 
▪ 
 
▪ 
beneficiário e cooperativa. Nesse primeiro momento, está disponível a contratação de 
apenas 1 evento:  
 
o LIQUIDAÇÃO: Onde o associado receberá informações de qualquer movimentação 
relacionada as liquidações de seus boletos, sejam elas: 
o LIQUIDACAO_PIX: Liquidações efetuadas via PIX. 
o LIQUIDACAO_REDE **: Liquidações efetuadas nos canais Sicredi. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 230 
 
 
 
 
Classificação da informação: Uso Irrestrito 
o LIQUIDACAO_COMPE_H5: Liquidações efetuadas em outras instituições (Fora da 
Rede SICREDI) 
o LIQUIDACAO_COMPE_H6: Liquidações com valor superior a 250 mil efetuadas em 
outras instituições (Fora da Rede SICREDI)  
o LIQUIDACAO_COMPE_H8: Recebimento de liquidação fora da Rede SICREDI-
Contingência (Alguma inconsistência de sistema). 
o LIQUIDACAO_CARTORIO: Liquidações efetuadas em cartórios. 
o ESTORNO_LIQUIDACAO_REDE: Liquidações que foram estornadas. 
 
 
       ** Observação LIQUIDAÇÃO_REDE: Essa liquidação é a única que pode ter 
estorno 
no 
mesmo 
dia. 
Havendo 
estorno 
será 
enviado 
o 
evento 
“ESTORNO_LIQUIDACAO_REDE”. Fica a critério do associado acatar de imediato a 
liquidação ou aguardar o fim do dia para garantir que não ocorreu um estorno.  
 
▪ 
 
▪ 
Altera Contrato Webhook: Operação responsável por alterar dados de um contrato através 
de um IdContrato. 
 
 
 
 
Observação: O tópico abaixo (22. Iniciando a Integração) é 
destinado para os usuários que não conhecem o processo de 
integração da API. Caso já tenha conhecimento neste processo, o 
de Contratação Webhook é realizada com as mesmas credenciais 
da API (Cobrança Online).  
 
22. Iniciando a integração 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 231 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Para iniciar a integração há um processo constituído de etapas sequenciais para Validação e 
Produção:  
 
3. Validação/Teste 
 
Acessar o Portal do Desenvolvedor: 
d. Criação de APP para Homologação 
f. Testes nas URLS  
 
b. Criação de APP para Homologação: para criar a APP de homologação, o desenvolvedor deve 
acessar o Portal do Desenvolvedor Sicredi (clique aqui) e criar uma conta ou logar. Após criar 
uma conta ou logar, o desenvolvedor deve clicar em ‘criar uma nova aplicação’. Ao criar uma 
SandBox’ para identificar que é a APP de homologação e selecionar a API da Cobrança [ API 
AUTH - OPENAPI - PARCEIROS 1.0.0]. Ao criar uma app você já terá um Client ID gerado 
automaticamente para essa APP. 
 
 
 
 
 
 
 
 
 
você deve, ainda no portal do desenvolvedor, clicar no menu suporte > abrir chamado. 
Selecione a opção “COLOCAR AQUI QUAL OPÇÃO”, e preencha o nome da APP com aquele 
selecionando a app criada e clicando em ‘ver detalhes’. 
 
 
 
 
 
 
 
 
 
1.Criando a APP no portal  
2. Selecionando as APIs na lista 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 232 
 
 
 
 
Classificação da informação: Uso Irrestrito 
c. Testes nas URLS: No decorrer desse manual você encontrará as URLs para teste dos 
recursos disponíveis em ambiente de homologação. 
 
3. Produção  
 
Acessar o Portal do Desenvolvedor 
d. Criação de APP para Produção 
 
Acessar o Internet Banking 
 
d. Criação de APP para produção: Para criar a APP de produção, você pode repetir os 
mesmos passos da criação da APP de homologação, no entanto, lembre-se de nomear 
essa nova APP de uma forma que você identifique que ela se trada da APP de produção, 
APP você terá acesso imediato ao Client ID de produção. 
 
disponibilizado no mesmo prazo anteriormente citado e poderá ser visualizado no menu 
minhas apps.  
 
 
 
 
 
 
 
 
 
 
 
 
 
É importante lembrar que em todas as operações será necessário informar no cabeçalho 
diferente para o ambiente de Homologação (Sandbox) e Produção, deve ser informado o 
 
f. 
Internet Banking, pela conta vinculada ao seu convênio de Cobrança, e selecionar a opção 
4. Visualizando as APPs no menu 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 233 
 
 
 
 
Classificação da informação: Uso Irrestrito 
exclusivamente para os beneficiários que possuem a modalidade API(Cobrança Online) 
habilitada no convênio.  
 
 
5. 
Se você ou a sua empresa associada não possui a modalidade habilitada e 
deseja habilitá-la, converse com a pessoa gerente de conta. 
 
A chave será gerada após informado o dispositivo de segurança. Ela deve ser armazenada e utilizada 
para permitir as operações. Caso o beneficiário possua mais de uma conta com o produto Cobrança 
 
23. Recursos disponíveis 
 
Em todas as operações será necessário informar no cabeçalho da requisição no campo x-api-key 
padrão JWT. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 234 
 
 
 
 
Classificação da informação: Uso Irrestrito 
O formato de entrada é “x-www-form-urlencoded” e saída é JSON, considerando que a saída 
codificação utilizado no Response é Unicode UTF-8. 
Observação: deve ser respeitada a orientação da segurança da informação referente a expiração 
“refresh_expires_in” (exemplo: 900 segundos) de retorno do serviço respectivamente. Os parâmetros de 
expiração (“expires_in” e “refresh_expires_in”) podem ser diferentes em Teste e Produção. 
“username” e “password”. 
usuário e senha (username e password).  
 
 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetro 
Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key String  
HeaderParam  
36 
UUID 
38 bits 
gerado no 
portal do 
desenvolvedor 
Obrigatório  
2 
context 
String 
HeaderParam 8 
COBRANCA 
Contexto, 
passar fixo 
“COBRANCA”  
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 235 
 
 
 
 
Classificação da informação: Uso Irrestrito 
3 
Content-
Type 
 
HeaderParam   
 application/x-
www-form-
urlencoded 
Indica o tipo 
de arquivo do 
recurso  
Obrigatório  
4 
grant_typ
e 
String 
Body 
Até 13 
password ou 
Tipo de 
pág 113 
Obrigatório 
5 
username String 
Body 
9 
Sem 
formatação 
beneficiário + 
Cooperativa 
Obrigatório 
para Grant 
Type  igual a 
password 
6 
password String 
Body 
64 
Sem 
formatação 
Acesso gerado 
no Internet 
Banking 
Obrigatório 
para Grant 
Type igual 
password 
7 
refresh_t
oken 
String 
Body 
753 
Sem 
formatação 
dígitos 
obtido 
anteriormente 
na 
Obrigatório 
para Grant 
Type igual a 
refresh_toke
n 
8 
scope 
String 
Body 
8 
cobranca 
Escopo de 
acesso. Passar 
fixo 
“cobranca”. 
Obrigatório 
para Grant 
Type 
password 
 
SAÍDA: 
Ord 
Nome 
Tipo 
Tipo de 
Parâmetro 
Formatação 
Descrição 
1  
String  
JSON  
576 bits  
para ser utilizado 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 236 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
RETORNO (Response): 
 
FALHAS: 
2  
String  
JSON  
2017-08-
09T08:53:11.679-
03:00 
3 
String 
JSON 
636 dígitos 
Será utilizado para gerar 
sem a necessidade de 
com usuário e senha 
4 
expires_in 
String 
JSON 
3 dígitos 
Tempo de expiração (em 
segundos) do Access 
5 
refresh_expires_in String 
JSON 
6 dígitos 
Tempo de expiração (em 
segundos) do Refresh 
6 
scope 
String 
JSON 
cobranca profile 
email 
Escopo que o usuário 
possui acesso. 
Descrição 
HTTP_OK (200)  
Operação realizada com sucesso  
Mensagem 
Parâmetros de 
entrada 
sujeitos a crítica 
Descrição 
HTTP_NOT_FOUND (404)  
ao realizar 
operação de 
Não possui  
(URL) inválido. Deve-se 
verificar a url utilizada. 
HTTP_UNAUTHORIZED (401)  
Invalid user 
credentials  
username, 
password, 
context 
username ou password não 
informado ou  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 237 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
 
URL Produção:  
 
RESPONSE: 
{ 
"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJxMlRFLXliYWxnNjIxSmRCMU9IX0w2Sms5QllxODJtNkFS
Z0NGaDZtQnZBIn0.eyJleHAiOjE2NTY0NTA5MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiZjNiYjg5YzQtOGRmM
y00OTMxLWExOTItMjUxMjUxZWE1YzNkIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGk
uY2xvdWQvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjozMWY3ODE1MS1jMzdmLTQzO
WYtYTIwOS02NjFjYTQ3MzkzYTE6Q09CUkFOQ0E6MDA0MTQwMTE2IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoib3Bl
bmFwaS1ndy1zZW5zZWRpYSIsInNlc3Npb25fc3RhdGUiOiIwNGQ3YTAwYS05MjhiLTQ3NzQtYTY1MC1mOWQx
ODkzNWE3NDMiLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbImRlZmF1bHQtcm9sZXMtb3BlbmFwa
SIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW
50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbG
UiXX19LCJzY29wZSI6ImNvYnJhbmNhIHByb2ZpbGUgZW1haWwiLCJzaWQiOiIwNGQ3YTAwYS05MjhiLTQ3NzQ
tYTY1MC1mOWQxODkzNWE3NDMiLCJvcGVuYXBpX3VzZXJuYW1lIjoiMDA0MTQwMTE2Iiwib3BlbmFwaV9jb2
50ZXh0IjoiQ09CUkFOQ0EiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6IjAwNDE0M
DExNiJ9.mVzfyzBhVFwRWVnQkbiD00zitoOfmatRcDN_e_OKo4XKcOY6RU-qlpJ0FOC-
_7Qy5ez7XveNeRyq47ToY6F0skbw-0BswxY3qdQHBr50G-
AxqICYLSUTEamrPc0vLNwADdPracL9P2W_EVEFLae7QeVzc0toNLjvaLJCaGZH6-
wV99qMjf0VUj5nRCUm6ZCllb3NioyI6mXsj0Ea1s8RdgnanWvgvD-
inválidos. 
HTTP_UNAUTHORIZED  
(401) 
Missing 
parameter: 
username 
username 
username não informado. 
HTTP_UNAUTHORIZED  
(401) 
Could not find a 
required Access 
request, 
identified by 
HEADER x-api-key 
x-api-key 
parâmetro x-api-key não foi 
informado ou está inválido. 
HTTP_BAD_REQUEST (400) 
Missing form 
parameter: 
grant_type 
grant_type 
parâmetro grant_type não é 
informado ou  
inválido. 
HTTP_GATEWAY_TIMEOUT 
(504) 
Gateway Timeout Não se aplica 
serviço não conseguiu 
responder no tempo 
esperado. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 238 
 
 
 
 
Classificação da informação: Uso Irrestrito 
cNjmCmMXVhy7U_MScLIb_7cIrn4TbcbkA3r11b96KzU9cp5BCXHZysDdX0wRFVzQUQfBsf33E40GSNJ-
juFZdV86vWCmx7BjKnC1s3embfX0p-9JnbNUy7Q", 
    "expires_in": 300, 
    "refresh_expires_in": 1800, 
"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJhMTRlOTdmOC1lZmJiLTQ2YTYtOTYwYy0wNTFlZjA4MT
U3MjEifQ.eyJleHAiOjE2NTY0NTI0MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiOWIyOWE3YjMtYzRhNS00NGQz
LTg3MjQtZWU4ZGQzYjIwNDAxIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGkuY2xvdW
QvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJodHRwczovL2F1dGgtb3BlbmFwaS5wcmQuc2ljcmVkaS5jbG91ZC9y
ZWFsbXMvb3BlbmFwaSIsInN1YiI6ImY6MzFmNzgxNTEtYzM3Zi00MzlmLWEyMDktNjYxY2E0NzM5M2ExOkNP
QlJBTkNBOjAwNDE0MDExNiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJvcGVuYXBpLWd3LXNlbnNlZGlhIiwic2Vzc2lvbl9z
dGF0ZSI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyIsInNjb3BlIjoiY29icmFuY2EgcHJvZ
mlsZSBlbWFpbCIsInNpZCI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyJ9.Om0gACw3fK
yfSnWyNhlElQSMYYtClCHrZYdGAIc4ul0", 
    "not-before-policy": 0, 
    "session_state": "04d7a00a-928b-4774-a650-f9d18935a743", 
    "scope": "cobranca profile email" 
} 
 
Execução (via ferramenta Postman) 
▪ 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 239 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
▪ 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 240 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 
 
 
▪ 
 
▪ 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 241 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 242 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
23.2. Realizar Contratação Webhook 
A operação POST “criar” é responsável por gerar um novo contrato Webhook. O formato de 
entrada e saída é JSON, considerando que a saída sempre é composta da entidade a ser retornada e um 
 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Parametro Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key 
String 
Header 
Param 
38 
UUID 
gerado no 
portal do 
desenvolvedor 
Obrigatório 
1 
Authorization 
String  
Header 
Param  
1413 
Campo 
obtido na saída 
da 
Obrigatório  
2 
Content-Type 
Application
/json 
Header 
param 
 
Sem formatação 
Estabelece o 
tipo de 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 243 
 
 
 
 
Classificação da informação: Uso Irrestrito 
conteúdo da 
requisição 
3 
cooperativa 
String 
Body 
4 
Sem formatação 
Cooperativa - 
Obrigatório 
4 
posto 
String  
 Body 
2  
Sem formatação  
Obrigatório  
5 
codBeneficiario 
String  
Body  
5  
Sem formatação  
Convênio de  
Cobrança  
Obrigatório  
7 
eventos 
List<String> Body 
 
Domínios: 
LIQUIDACAO 
Eventos enviados via 
Webhook 
Obrigatório 
8 
url 
String  
Body  
256 
Sem formatação 
URL de integração 
entre Sicredi e 
associado. 
Obs: A url deve 
possuir, 
obrigatoriamente, o 
protocolo (https) 
Obrigatório  
9 
String 
Body 
10 
Domínios: ATIVO, 
INATIVO, 
BLOQUEADO 
está sendo utilizada 
na comunicação. 
Obrigatório 
10 
String 
Body 
10 
Domínios: ATIVO, 
INATIVO, 
BLOQUEADO 
gerado 
Obrigatório 
11 
nomeResponsavel 
String 
Body 
50 
Sem formatação 
Nome do 
responsável pelo 
contrato 
Opcional 
12 
email 
String 
Body 
40 
Sem formatação 
Email do 
responsável 
Opcional  
13 
telefone 
String 
Body 
20 
Sem formatação 
Telefone do 
Responsável 
Opcional 
14 
enviarIdTituloEmp
resa 
Boolean 
Body 
 
Domínios: 
true/false 
Flag que indica se 
ao enviar o evento 
de liquidação, caso 
o título possua 
‘idTituloEmpresa’ 
essa informação 
será enviada no 
evento. 
Opcional 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 244 
 
 
 
 
Classificação da informação: Uso Irrestrito 
15 
header 
String 
Body 
 
Sem formatação 
Obs: Só informar 
esse campo se sua 
API de recebimento 
de eventos possuir 
algum tipo de 
ser acessada. 
 
Valor da secret-id 
Opcional 
16 
String 
Body 
 
Sem formatação 
Obs: Só informar 
esse campo se sua 
API de recebimento 
de eventos possuir 
algum tipo de 
ser acessada. 
 
Valor da senha 
Opcional 
 
SAÍDA: 
Ord 
Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
idContrato 
String 
25 
Sem formatação  
Identificador único do 
contrato.  
2 
cooperativa 
String 
4 
Sem formatação 
Beneficiário. 
3 
posto 
String 
2 
Sem formatação 
Beneficiário. 
4 
codBeneficiario  
String  
5 
Sem formatação 
Cobrança. 
5 
eventos  
List<String>   
Domínios:  
"LIQUIDACAO_PIX", 
"LIQUIDACAO_COMPE_H5", 
"LIQUIDACAO_COMPE_H6", 
"LIQUIDACAO_COMPE_H8", 
* "LIQUIDACAO_REDE",  
"LIQUIDACAO_CARTORIO" 
"AVISO_PAGAMENTO_COMPE", 
"ESTORNO_LIQUIDACAO_REDE" 
 
Lista de eventos que o 
associado receberá 
informações em caso de 
movimentação. 
 
"LIQUIDACAO_REDE"  
*Obs: Essa liquidação é a 
única 
que 
pode 
ter 
estorno no mesmo dia. 
Havendo 
estorno 
será 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 245 
 
 
 
 
Classificação da informação: Uso Irrestrito 
enviado 
o 
evento 
“ESTORNO_LIQUIDACAO 
_REDE”.  
Fica 
a 
critério 
do 
associado 
acatar 
de 
imediato a liquidação ou 
aguardar o fim do dia para 
garantir que não ocorreu 
um estorno. 
 
6 
url  
String  
256 
Sem formatação 
URL de integração entre 
Sicredi e associado 
7 
String  
10 
Domínios: ATIVO, INATIVO, 
BLOQUEADO 
sendo utilizada na 
comunicação. 
8 
String 
10 
Domínios: ATIVO, INATIVO, 
BLOQUEADO 
9 
nomeResponsavel 
String 
50 
Sem formatação 
Nome do responsável 
pelo contrato 
10 
Email 
String  
40 
Sem formatação 
Email do responsável 
11 
telefone 
String 
20 
Sem formatação 
Telefone do Responsável 
12 
header 
String 
 
Sem formatação 
Valor da secret-id 
 
13 
String 
 
Sem formatação 
Valor da senha 
 
14 
enviarIdTituloEmpresa Boolean 
 
Domínios: true/false 
Flag que indica se envia 
‘idTituloEmpresa’ 
 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (201)  
Operação aceita com sucesso 
 
 
FALHAS: 
Mensagem 
Parâmetros sujeitos 
à crítica 
Descrição 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 246 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_NOT_FOUND (404)  
realizar operação de 
Não possui  
HTTP_UNSUPPORTED_MEDIA
_TYPE (415) 
Tipo de conteúdo 
não suportado 
Parâmetro: 
Content-Type 
obrigatório não informado ou 
inválido. 
 
HTTP_UNAUTHORIZED (401) 
Unauthorized 
Parâmetro: 
Authorization 
obrigatório não informado ou 
inválido. 
HTTP_UNAUTHORIZED 
(401) 
 
Cooperativa 
diferente da 
cooperativa do 
usuário 
 
Parâmetro: 
cooperativa 
 
for diferente do contido na 
 
HTTP_UNAUTHORIZED 
(401) 
 
beneficiário 
diferente do 
beneficiário do 
usuário 
 
Parâmetro: 
codigoBeneficiario 
 
for diferente do contido na 
 
HTTP_BAD_REQUEST (400)  
Campo obrigatório 
em branco  
Qualquer parâmetro 
que consta como 
obrigatório na 
listagem de 
parâmetros de 
entrada pode ser 
criticado  
obrigatórios não informados ou  
inválidos.  
HTTP_BAD_REQUEST (400)  
“Cooperativa 
inválida” 
Parâmetro: 
cooperativa 
obrigatórios não preenchidos ou 
inválidos. 
HTTP_BAD_REQUEST (400) 
“Posto inválido” 
Parâmetro: 
 posto 
obrigatórios não preenchidos ou 
inválidos 
HTTP_BAD_REQUEST (400) 
 
“Evento deve conter 
LIQUIDACAO” 
Parâmetro: 
 evento 
obrigatório não informado ou 
inválido. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 247 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
 
“URL é obrigatória” 
Parâmetro: 
  url 
obrigatório não informado ou 
inválido. 
HTTP_BAD_REQUEST (400) 
 
“URL inválida” 
 
Parâmetro:  
   url 
 
O campo foi preenchido em branco 
("") ou o tipo de protocolo 
informado foi diferente de "http" ou 
"https".  
HTTP_BAD_REQUEST (400) 
 
informado ou está 
inválida” 
Parâmetro: 
O parâmetro não foi informado ou 
foi preenchido com valor inválido. 
HTTP_BAD_REQUEST (400) 
 
deve ser ATIVO, 
INATIVO, 
BLOQUEADO” 
Parâmetro: 
com um valor diferente dos 
domínios: ATIVO, INATIVO, 
BLOQUEADO 
HTTP_BAD_REQUEST (400) 
 
obrigatório” 
Parâmetro: 
O campo "contratoStatrus" não foi 
preenchido. 
 
HTTP_BAD_REQUEST (400) 
 
O campo Contrato 
ATIVO, INATIVO ou 
BLOQUEADO. 
Parâmetro: 
contratoStauts 
preenchido com um valor diferente 
dos domínios: ATIVO, INATIVO, 
BLOQUEADO 
HTTP_BAD_REQUEST (400) 
 
“Email inválido” 
Parâmetro: 
 email 
O campo “email” foi preenchido com 
um endereço de email inválido. 
Exemplo: Sem o @. 
UNPROCESSABLE_ENTITY 
(422)  
“Contrato já 
existente.” 
 
 
Já existe um contrato cadastrado 
com os mesmos dados (coop e bnf) 
 
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/webhook/contrato/ 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
 
REQUEST BODY (JSON): 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 248 
 
 
 
 
Classificação da informação: Uso Irrestrito 
{    
    "cooperativa": "0123",   
    "posto": "12",   
    "codBeneficiario": "12345",    
    "eventos": [ 
        "LIQUIDACAO"     
    ],    
    "url": "https://teste.instituicao.cloud/v1/contratos",    
    "nomeResponsavel": "NOME RESPONSAVEL",    
    "email": "TESTE@EMAIL.COM.BR",   
    "telefone": "51 999999999"     
} 
 
RESPONSE BODY (JSON):  
{ 
    "idContrato": "63a241a590364b703bbe6aac", 
    "cooperativa": "0123", 
    "posto": "12", 
    "codBeneficiario": "12345", 
    "eventos": [ 
        "LIQUIDACAO_PIX", 
        "LIQUIDACAO_COMPE_H5", 
        "LIQUIDACAO_COMPE_H6", 
        "LIQUIDACAO_COMPE_H8", 
        "LIQUIDACAO_REDE", 
        "LIQUIDACAO_CARTORIO", 
        "AVISO_PAGAMENTO_COMPE", 
        "ESTORNO_LIQUIDACAO_REDE" 
    ], 
    "url": "https://teste.instituicao.cloud/v1/contratos", 
    "nomeResponsavel": "NOME RESPONSAVEL", 
    "email": "TESTE@EMAIL.COM.BR", 
    "telefone": "51 999999999" 
} 
Execução (via ferramenta Postman) 
▪ 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 249 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
▪ 
 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 250 
 
 
 
 
Classificação da informação: Uso Irrestrito 
contratos de um determinado beneficiário. Nesse método você verificar seus contratos ATIVOS, INATIVOS 
ou BLOQUEADOS, bem como os dados do seu contrato. O formato de entrada é sempre JSON, e a saída 
sucesso, e JSON, em caso de falha. 
Entrada: 
Ord  
Nome  
Tipo  
Tipo de  
Parâmetro  
Tamanho 
Formatação  
Descrição  
Obrigatório  
1  
x-api-key  
String  
HeaderParam  
36 
UUID  
fornecido pelo 
Sicredi  
Obrigatório  
2   
Authorization  String   HeaderParam   
1413 
Obrigatório   
3  
cooperativa   String   QueryParam   
4 
Sem formatação 
cooperativa.   
Obrigatório  
 
posto 
String 
QueryParam 
4 
Sem formatação 
Obrigatório 
 
beneficiário 
String 
QueryParam 
5 
Sem formatação 
Beneficiário 
Obrigatório 
 
Saída:  
Ord Nome 
Tipo 
Tamanho Formatação 
Descrição 
1  
idContrato 
String 
25 
Sem formatação  
Identificador único do 
contrato.  
2 
cooperativa 
String 
4 
Sem formatação 
do Beneficiário. 
3 
posto 
String 
2 
Sem formatação 
Beneficiário. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 251 
 
 
 
 
Classificação da informação: Uso Irrestrito 
4 
codBeneficiario  
String  
5 
Sem formatação 
de Cobrança. 
5 
eventos  
List<String>   
Domínios:  
"LIQUIDACAO_PIX","LIQUIDACAO_COMPE
_H5", 
"LIQUIDACAO_COMPE_H6", 
"LIQUIDACAO_COMPE_H8", 
"LIQUIDACAO_REDE","LIQUIDACAO_CART
ORIO" 
"AVISO_PAGAMENTO_COMPE", 
"ESTORNO_LIQUIDACAO_REDE" 
 
Lista de eventos que o 
associado receberá 
informações em caso de 
movimentação. 
6 
url  
String  
256 
Sem formatação 
URL de integração entre 
Sicredi e associado 
7 
String  
10 
Domínios: ATIVO, INATIVO, BLOQUEADO 
sendo utilizada na 
comunicação. 
8 
String 
10 
Domínios: ATIVO, INATIVO, BLOQUEADO 
gerado 
9 
nomeResponsavel 
String 
50 
Sem formatação 
Nome do responsável 
pelo contrato 
10 
Email 
String  
40 
Sem formatação 
Email do responsável 
11 
telefone 
String 
20 
Sem formatação 
Telefone do Responsável 
12 
enviarIdTituloEmpresa Boolean 
 
Domínios: true/false  
Flag que indica se envia 
‘idTituloEmpresa’ 
13 
header 
String 
 
Sem formatação 
Valor da secret-id 
14 
String 
 
Sem formatação 
Valor da senha 
 
FALHAS: 
Mensagem  
Parâmetros de 
entrada  
sujeitos a crítica  
Descrição  
HTTP_UNAUTHORIZED (401)  
Could not find a required 
request, identified by 
HEADER x-api-key  
Parâmetro:  
x-api-key  
parâmetros obrigatórios não 
informados ou inválidos.  
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 252 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED (401)  
UNAUTHORIZED  
Parâmetro:  
Authorization  
parâmetros obrigatórios não 
informados ou inválidos.  
 
HTTP_UNAUTHORIZED (401)  
diferente do beneficiário 
do usuário 
Parâmetro: 
linhaDigitavel 
digitável informada é de 
beneficiário e/ou agência 
diferente. 
HTTP_BAD_REQUEST (400)   
“Cooperativa inválida”.   Parâmetro:  
cooperativa  
parâmetros obrigatórios não 
informados ou inválidos.   
HTTP_BAD_REQUEST (400) 
“Posto Inválido” 
Parâmetro: 
posto 
parâmetros obrigatórios não 
informados ou inválidos.  
HTTP_BAD_REQUEST (400) 
inválido” 
Parâmetro: 
beneficiario 
parâmetros obrigatórios não 
informados ou inválidos. 
UNPROCESSABLE_ENTITY (422) 
“Nenhum contrato 
encontrado” 
beneficiário pesquisado não 
possua contrato. 
 
REQUEST – GET:  
URL Produção:  
https://api-
parceiro.sicredi.com.br/cobranca/boleto/v1/webhook/contratos/?cooperativa=0100&posto=99&beneficiari
o=12345 
HEADERS: 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 253 
 
 
 
 
Classificação da informação: Uso Irrestrito 
Authorization 
x-api-key 
 
PARAM: 
cooperativa 
posto 
beneficiario 
Execução (via ferramenta Postman) 
 
▪ 
Parâmetros:  
 
▪ 
Headers:  
 
 
▪ 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 254 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
 
▪ 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 255 
 
 
 
 
Classificação da informação: Uso Irrestrito 
▪ 
Cenário Negativo: 400 – Bad Request (Cooperativa inválida) 
 
 
▪ 
Cenário Negativo: 401 – UNAUTHORIZED 
 
 
 
23.4. Altera Contrato Webhook 
A operação PUT “criar/alterar” é responsável por alterar dados de um contrato Webhook já 
existente. O formato de entrada e saída é JSON, considerando que a saída sempre é composta da 
Response é Unicode UTF-8. Por padrão o recurso de alterar responde em milissegundos. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 256 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
ENTRADA: 
Ord 
Nome 
Tipo 
Parametro Tamanho 
Formatação 
Descrição 
Obrigatório 
1 
x-api-key 
String 
Header 
Param 
38 
UUID 
gerado no 
portal do 
desenvolvedor 
Obrigatório 
2 
Authorization 
String  
Header 
Param  
1413 
Campo 
obtido na saída 
da 
Obrigatório  
3 
Content-Type 
Application
/json 
Header 
param 
 
Sem formatação 
Estabelece o 
tipo de 
conteúdo da 
requisição 
 
4 
idContrato  
String  
Patch  
25  
Sem formatação  
Identificador 
único do 
contrato 
Obrigatório  
5 
cooperativa 
String 
Body 
4 
Sem formatação 
Cooperativa - 
Obrigatório 
6 
posto 
String  
 Body 
2  
Sem formatação  
Obrigatório  
7 
codBeneficiario 
String  
Body  
5  
Sem formatação  
Convênio de  
Cobrança  
Obrigatório  
8 
eventos 
List<String> Body 
 
Domínios: 
LIQUIDACAO 
Eventos enviados via 
Webhook 
Obrigatório 
9 
url 
String  
Body  
256 
Sem formatação 
URL de integração 
entre Sicredi e 
associado. 
Obs: A url deve 
possuir, 
obrigatoriamente, o 
protocolo (https) 
Obrigatório  
10 
String 
Body 
10 
Domínios: ATIVO, 
INATIVO, 
BLOQUEADO 
está sendo utilizada 
na comunicação. 
Obrigatório 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 257 
 
 
 
 
Classificação da informação: Uso Irrestrito 
11 
String 
Body 
10 
Domínios: ATIVO, 
INATIVO, 
BLOQUEADO 
gerado 
Obrigatório 
12 
nomeResponsavel 
String 
Body 
50 
Sem formatação 
Nome do 
responsável pelo 
contrato 
Opcional 
13 
email 
String 
Body 
40 
Sem formatação 
Email do 
responsável 
Opcional  
14 
telefone 
String 
Body 
20 
Sem formatação 
Telefone do 
Responsável 
Opcional 
15 
enviarIdTituloEmp
resa 
Boolean 
Body 
 
Domínios: 
true/false 
Flag que indica se 
ao enviar o evento 
de liquidação, caso 
o título possua 
‘idTituloEmpresa’ 
essa informação 
será enviada no 
evento. 
Opcional 
16 
header 
String 
Body 
 
Sem formatação 
Obs: Só informar 
esse campo se sua 
API de recebimento 
de eventos possuir 
algum tipo de 
ser acessada. 
 
Valor da secret-id 
Opcional 
17 
String 
Body 
 
Sem formatação 
Obs: Só informar 
esse campo se sua 
API de recebimento 
de eventos possuir 
algum tipo de 
ser acessada. 
 
Valor da secret-id 
Opcional 
 
SAÍDA: 
Ord 
Nome 
Tipo 
Tamanho Formatação 
Descrição 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 258 
 
 
 
 
Classificação da informação: Uso Irrestrito 
1  
idContrato 
String 
25 
Sem formatação  
Identificador único do 
contrato.  
2 
cooperativa 
String 
4 
Sem formatação 
do Beneficiário. 
3 
posto 
String 
2 
Sem formatação 
Beneficiário. 
4 
codBeneficiario  
String  
5 
Sem formatação 
de Cobrança. 
5 
eventos  
List<String>   
Domínios:  
"LIQUIDACAO_PIX", 
"LIQUIDACAO_COMPE_H5", 
"LIQUIDACAO_COMPE_H6", 
"LIQUIDACAO_COMPE_H8", 
* "LIQUIDACAO_REDE",  
"LIQUIDACAO_CARTORIO" 
"AVISO_PAGAMENTO_COMPE", 
"ESTORNO_LIQUIDACAO_REDE" 
 
Lista de eventos que o 
associado receberá 
informações em caso de 
movimentação. 
 
"LIQUIDACAO_REDE"  
*Obs: Essa liquidação é a 
única 
que 
pode 
ter 
estorno no mesmo dia. 
Havendo estorno será 
enviado 
o 
evento 
“ESTORNO_LIQUIDACAO 
_REDE”.  
Fica 
a 
critério 
do 
associado 
acatar 
de 
imediato a liquidação ou 
aguardar o fim do dia 
para garantir que não 
ocorreu um estorno. 
 
6 
url  
String  
256 
Sem formatação 
URL de integração entre 
Sicredi e associado 
7 
String  
10 
Domínios: ATIVO, INATIVO, 
BLOQUEADO 
sendo utilizada na 
comunicação. 
8 
String 
10 
Domínios: ATIVO, INATIVO, 
BLOQUEADO 
gerado 
9 
nomeResponsavel 
String 
50 
Sem formatação 
Nome do responsável 
pelo contrato 
10 
Email 
String  
40 
Sem formatação 
Email do responsável 
11 
telefone 
String 
20 
Sem formatação 
Telefone do Responsável 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 259 
 
 
 
 
Classificação da informação: Uso Irrestrito 
12 
enviarIdTituloEmpresa Boolean 
 
Domínios: true/false  
Flag que indica se envia 
‘idTituloEmpresa’ 
13 
header 
String 
 
Sem formatação 
Valor da secret-id 
14 
String 
 
Sem formatação 
Valor da senha 
 
RETORNO (Response): 
Descrição  
HTTP_ACCEPTED (200)  
Operação aceita com sucesso 
 
 
 
 
 
 
FALHAS: 
Mensagem 
Parâmetros sujeitos 
à crítica 
Descrição 
HTTP_NOT_FOUND (404)  
realizar operação de 
Não possui  
HTTP_UNSUPPORTED_MEDIA_TY
PE (415) 
Tipo de conteúdo 
não suportado 
Parâmetro: 
Content-Type 
obrigatório não informado ou 
inválido. 
 
HTTP_UNAUTHORIZED (401) 
Unauthorized 
Parâmetro: 
Authorization 
obrigatório não informado ou 
inválido. 
HTTP_UNAUTHORIZED 
(401) 
 
Cooperativa 
diferente da 
cooperativa do 
usuário 
 
Parâmetro: 
cooperativa 
 
for diferente do contido na 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 260 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_UNAUTHORIZED 
(401) 
 
beneficiário 
diferente do 
beneficiário do 
usuário 
 
Parâmetro: 
codigoBeneficiario 
 
for diferente do contido na 
 
HTTP_UNAUTHORIZED 
(422) 
 
procurar contrato.” 
Parâmetro: 
 Pacth: id 
contrato informado corresponde a 
um id que não existe na base de 
dados. 
HTTP_BAD_REQUEST (400)  
Campo obrigatório 
em branco  
Qualquer parâmetro 
que consta como 
obrigatório na 
listagem de 
parâmetros de 
entrada pode ser 
criticado  
obrigatórios não informados ou  
inválidos.  
HTTP_BAD_REQUEST (400)  
“Cooperativa 
inválida” 
Parâmetro: 
cooperativa 
obrigatórios não preenchidos ou 
inválidos. 
HTTP_BAD_REQUEST (400) 
“Posto inválido” 
Parâmetro: 
 posto 
obrigatórios não preenchidos ou 
inválidos 
HTTP_BAD_REQUEST (400) 
 
“Evento deve conter 
LIQUIDACAO” 
Parâmetro: 
 evento 
obrigatório não informado ou 
inválido. 
HTTP_BAD_REQUEST (400) 
 
“URL é obrigatória” 
Parâmetro: 
  url 
obrigatório não informado ou 
inválido. 
HTTP_BAD_REQUEST (400) 
 
“URL inválida” 
 
Parâmetro:  
   url 
 
O campo foi preenchido em branco 
("") ou o tipo de protocolo 
informado foi diferente de "http" ou 
"https".  
HTTP_BAD_REQUEST (400) 
 
informado ou está 
inválida” 
Parâmetro: 
O parâmetro não foi informado ou 
foi preenchido com valor inválido. 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 261 
 
 
 
 
Classificação da informação: Uso Irrestrito 
HTTP_BAD_REQUEST (400) 
 
deve ser ATIVO, 
INATIVO, 
BLOQUEADO” 
Parâmetro: 
com um valor diferente dos 
domínios: ATIVO, INATIVO, 
BLOQUEADO 
HTTP_BAD_REQUEST (400) 
 
obrigatório” 
Parâmetro: 
O campo "contratoStatrus" não foi 
preenchido. 
 
HTTP_BAD_REQUEST (400) 
 
O campo Contrato 
ATIVO, INATIVO ou 
BLOQUEADO. 
Parâmetro: 
contratoStauts 
preenchido com um valor diferente 
dos domínios: ATIVO, INATIVO, 
BLOQUEADO 
HTTP_BAD_REQUEST (400) 
 
“Email inválido” 
Parâmetro: 
 email 
O campo “email” foi preenchido com 
um endereço de email inválido. 
Exemplo: Sem o @. 
 
 
 
REQUEST – GET:  
URL Produção:  
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/webhook/contrato/{id} 
HEADERS: 
Authorization 
x-api-key 
Content-Type: application/json 
 
PATH: 
id 
 
 
 
REQUEST BODY (JSON): 
{    
    "cooperativa": "0123",   
    "posto": "12",   
    "codBeneficiario": "12345",    
    "eventos": [ 
        "LIQUIDACAO"     
    ],    
    "url": "https://teste.instituicao.cloud/v1/contratos",    


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 262 
 
 
 
 
Classificação da informação: Uso Irrestrito 
    "nomeResponsavel": "NOME RESPONSAVEL",    
    "email": "TESTE@EMAIL.COM.BR",   
    "telefone": "51 999999999"     
} 
 
RESPONSE BODY (JSON):  
{ 
    "idContrato": "63a241a590364b703bbe6aac", 
    "cooperativa": "0123", 
    "posto": "12", 
    "codBeneficiario": "12345", 
    "eventos": [ 
        "LIQUIDACAO_PIX", 
        "LIQUIDACAO_COMPE_H5", 
        "LIQUIDACAO_COMPE_H6", 
        "LIQUIDACAO_COMPE_H8", 
        "LIQUIDACAO_REDE", 
        "LIQUIDACAO_CARTORIO", 
        "AVISO_PAGAMENTO_COMPE", 
        "ESTORNO_LIQUIDACAO_REDE" 
    ], 
    "url": "https://teste.instituicao.cloud/v1/contratos", 
    "nomeResponsavel": "NOME RESPONSAVEL", 
    "email": "TESTE@EMAIL.COM.BR", 
    "telefone": "51 999999999" 
} 
Execução (via ferramenta Postman) 
 
▪ 
Body Request:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 263 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
▪ 
Headers/Path Param:  
 
 
▪ 
Cenário Positivo:  


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 264 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
 
▪ 
 
 
 
 


Manual API da Cobrança 
Cobrança 
 
 
 
 
11/11/2025 Versão - 3.9 
Página 265 
 
 
 
 
Classificação da informação: Uso Irrestrito 
 
▪ Beneficiário: Empresa ou pessoa associada do Sicredi que contratou o produto Cobrança 
com a sua cooperativa. 
 
contratação do produto Cobrança na sua agência.  
 
▪ Número da cooperativa: É o número da cooperativa a qual pertence a conta vinculada ao 
convênio de cobrança da pessoa associada. Esse número é o qual junto com o número de 
conta o associado pode logar no seu internet banking. 
 
▪ Número de posto: É o número da agência a qual pertence a conta vinculada ao convênio 
de Cobrança da pessoa associada. Você pode encontrar essa informação acessando (ou 
solicitando à empresa associada que acesse) o internet banking, no menu “Cobrança”, na 
opção ‘Cadastrar títulos’. Ela encontrará a seguinte informação:  
 
 
 
1234 
12346 
46 
NOME DA EMPRESA 
Posto 
Cooperativa