Manual Da API Da Cobrança 1.2

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

Manual API da Cobrança Cobrança
27/06/2022 – Versão 1.0
Sumário
1. Apresentação ..................................................................................................... 3
2. Para quem? ........................................................................................................ 4
3. Objetivo ............................................................................................................. 4
4. Orientações Iniciais............................................................................................ 4
5. Quais as funcionalidades? ................................................................................. 5
6. Iniciando a integração ....................................................................................... 6
7. Recursos disponíveis.......................................................................................... 8
7.1. Autenticação ...................................................................................................... 8
URL Sandbox (ambiente para homologação): ....................................................................................................... 12
URL Produção: .................................................................................................................................................. 12
Execução (via ferramenta Postman) .............................................................................................................. 13
7.2. Cadastro de Boletos......................................................................................... 17
URL Sandbox (Ambiente para homologação): ....................................................................................................... 35
URL Produção: .................................................................................................................................................. 35
7.3. Impressão de Boletos ...................................................................................... 38
URL Produção: .................................................................................................................................................. 40
7.4. Comando de Instrução - Pedido de Baixa ....................................................... 43
URL Sandbox (ambiente de homologação): .......................................................................................................... 46
URL Produção: .................................................................................................................................................. 46
7.5. Comando de Instrução - Alteração de Vencimento ....................................... 50
URL Produção: .................................................................................................................................................. 54
7.6. Comando de Instrução - Alteração de Desconto ............................................ 58
URL Produção: .................................................................................................................................................. 63
27/06/2022 Versão - 1.0 Página 2


7.7. Comando de Instrução - Alteração de Data de Desconto .............................. 67
URL Produção: .................................................................................................................................................. 71
7.8. Comando de Instrução - Alteração de Juros................................................... 75
URL Produção: .................................................................................................................................................. 79
7.9. Comando de Instrução - Alteração de Seu Número ....................................... 82
URL Produção: .................................................................................................................................................. 86
7.10. Consulta de Boletos por Nosso Número ......................................................... 90
URL Produção: .................................................................................................................................................. 96
7.11. Consulta de Boletos Liquidados por Dia ........................................................ 100
URL Sandbox (ambiente para homologação): ..................................................................................................... 104
URL Produção: ................................................................................................................................................ 104
Execução (via ferramenta Postman) ............................................................................................................ 106
8. Geração Nosso Número................................................................................. 108
9. Layout do Boleto............................................................................................ 110
10. Glossário ........................................................................................................ 111
11. Fluxos ............................................................................................................. 113
11.1. Diagrama de Sequência de chamadas realizadas para o serviço .................. 113
11.2. 113
1. Apresentação
A API de Cobrança do Sicredi realiza o cadastro de boletos, além de geração de PDF, consultas e
Comando de instrução para gestão da sua carteira de boletos, através de integração com seu sistema de
gestão, seu site ou seu app. O uso da API de Cobrança traz benefícios como: boletos imediatamente
27/06/2022 Versão - 1.0 Página 3

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.
Novas funcionalidades serão adicionadas e comunicadas ainda em 2022.
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).
Ao contratar o produto é gerado o código do beneficiário (código do convênio) e o seu uso será
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:
▪ Ter contratado o produto Cobrança através da sua cooperativa;
27/06/2022 Versão - 1.0 Página 4

▪ 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:
▪ Autenticação: Operação responsável pela autenticação do código de acesso e criação do

token de autenticação, que permitirá acessar a API de Cobrança.
▪ Cadastro de Boletos: Operação responsável pelo registro do boleto. Com a opção de dois
tipos de cobrança:
o Boleto tradicional: Operação responsável pelo cadastro do pagador, do boleto, do

informativo e das mensagens relacionadas ao boleto a ser criado. Essa opção trata-
se de um boleto com a criação de linha digitável e código de barras.
o Boleto Híbrido: Operação responsável pelo cadastro do pagador, e de todos os

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,
se pela leitura do código de barras ou pelo QR Code. Para cadastrar boletos
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.
▪ Impressão de Boletos: Operação responsável pela impressão e reimpressão (2ª via) dos
dados de boletos já emitidos, tradicionais ou híbridos.
▪ Comando de Instrução – Pedido de Baixa: Operação responsável por solicitar o pedido de

baixa do boleto.
▪ Comando de Instrução – Alteração de Vencimento: Operação responsável por solicitar a

alteração da data de vencimento do boleto.
▪ Comando de Instrução – Alteração de Desconto: Operação responsável por solicitar a

alteração do valor de desconto do boleto.
▪ Comando de Instrução – Alteração de Data de Desconto: Operação responsável por

solicitar a alteração da data de desconto do boleto.
27/06/2022 Versão - 1.0 Página 5

▪ Comando de Instrução – Alteração de Juros: Operação responsável por solicitar a alteração

do valor/percentual de juros do boleto.
▪ Comando de Instrução – Alteração de Seu Número: Operação responsável por solicitar a

alteração do seu número do boleto.
▪ Consulta de Boletos por Nosso Número: Operação responsável pela consulta de um
determinado boleto, através do Nosso Número.
▪ Consulta de Boletos Liquidados por Dia: Operação responsável pela consulta de boletos
liquidados, de uma data específica.
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
b. Solicitação do Access Token de Homologação (Sandbox)
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 uma
nova aplicação deve nomeá-la com o prefixo ‘API Cobrança <Coop> <Código Beneficiário >
SandBox’ para identificar que é a APP de homologação e selecionar a API da Cobrança [ API
COBRANÇA BOLETO 1.0.0 ] e a API de Autenticação Parceiros na lista de APIs disponíveis [API
AUTH - OPENAPI - PARCEIROS 1.0.0]. Ao criar uma app você já terá um Client ID gerado
automaticamente para essa APP.
1.Criando a APP no portal 2. Selecionando as APIs na lista
27/06/2022 Versão - 1.0 Página 6

b. Geração do Access Token de Homologação (Sandbox): após criar a APP de Homologação,

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
nome que você criou no passo anterior. Pronto, o seu Acess token será gerado e dentro
de X dias você poderá visualizar o seu token de homologação no menu ‘minhas apps’,
selecionando a app criada e clicando em ‘ver detalhes’.
3. Visualizando o access token

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
b. Solicitação do Access Token de Produção
Acessar o Internet Banking

c. Geração da Código de acesso (password) no internet banking;
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,
nossa sugestão é: ‘API Cobrança <Coop> <Código Beneficiário > Produção’. Após criar a
APP você terá acesso imediato ao Client ID de produção.
b. Geração do Access Token de Produção: Repita os mesmos passos já realizados para a

geração de token de homologação, mas dessa vez ao abrir o chamado, preencha o campo
Client ID ou Nome da APP com os dados da APP de produção. O seu token será
disponibilizado no mesmo prazo anteriormente citado e poderá ser visualizado no menu
minhas apps.
4. Visualizando as APPs no menu
27/06/2022 Versão - 1.0 Página 7

É importante lembrar que em todas as operações será necessário informar no cabeçalho

da requisição no campo x-api-key o token de autenticação recebido. Esse token é
diferente para o ambiente de Homologação (Sandbox) e Produção, deve ser informado o
token correspondente ao ambiente que está sendo utilizado.
c. Geração do Código de Acesso (password): a empresa ou pessoa associada deve acessar o

Internet Banking, pela conta vinculada ao seu convênio de Cobrança, e selecionar a opção
de menu no: Cobrança >> Código de Acesso >> Gerar - Esse menu é apresentado
exclusivamente para os beneficiários que possuem a modalidade API(Cobrança Online)
habilitada no convênio.
5. Geração de Código de Acesso (password)
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
na configuração da integração da API, pois esse código gerado é utilizado no recurso de autenticação
para permitir as operações. Caso o beneficiário possua mais de uma conta com o produto Cobrança
contratado e deseje utilizá-las, precisará gerar o token de autenticação para cada conta específica.
7. Recursos disponíveis
7.1. Autenticação
27/06/2022 Versão - 1.0 Página 8

Em todas as operações será necessário informar no cabeçalho da requisição no campo x-api-key

o token de autenticação recebida do Sicredi. Esse token é diferente para o ambiente de Sandbox e
Produção, deve ser informado o token correspondente ao ambiente que está sendo utilizado.
A operação POST “token” é responsável por criar uma chave criptografada, denominada
“access_token”, utilizando o Beneficiário + Cooperativa como usuário (username) e o Código de Acesso
(password) que foi gerada no Internet Banking. O padrão de autenticação é o OAuth2 e o token utiliza o
padrão JWT.
O formato de entrada é “x-www-form-urlencoded” e saída é JSON, considerando que a saída
sempre é composta da entidade a ser retornada e um código HTTP dentro de um Response. O tipo de
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
do access_token e do refresh_token, observando os parâmetros “expires_in” (exemplo: 300 segundos) e
“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.
Para verificar se o acess_token está expirado, deve-se observar o campo “expires_in” que retorna
a duração do token em segundos.
O access_token deve ser enviado no cabeçalho das chamadas das próximas operações até que ele
expire, não deve ser realizado autenticação a cada chamada. Quando o access_token expirar, deve ser
utilizado o refresh_token para gerar um novo token.
OBS: Quando da utilização do refresh_token, não será necessário informar os campos
“username” e “password”.
Quando o refresh_token estiver expirado, deverá ser realizado o fluxo de autenticação normal, com
usuário e senha (username e password).
ENTRADA:
Tipo de
Ord Nome Tipo Tamanho Formatação Descrição Obrigatório
Parâmetro
1 x-api-key String HeaderParam 36 UUID Access token Obrigatório

38 bits gerado no
portal do
desenvolvedor
2 context String HeaderParam 8 COBRANCA Contexto, Obrigatório

passar fixo
“COBRANCA”
27/06/2022 Versão - 1.0 Página 9

3 Content- HeaderParam application/x- Indica o tipo Obrigatório

Type www-form- de arquivo do
urlencoded recurso
4 grant_typ String Body Até 13 password ou Tipo de Obrigatório

e refresh_token autenticação.
Ver diagrama,
pág 113
5 username String Body 9 Sem Código do Obrigatório

formatação beneficiário + para Grant
Código da Type igual a
Cooperativa password
6 password String Body 64 Sem Código de Obrigatório

formatação Acesso gerado para Grant
no Internet Type igual
Banking password
7 refresh_t String Body 753 Sem Refresh token Obrigatório

oken formatação obtido para Grant
dígitos anteriormente Type igual a
na refresh_toke
autenticação n
8 scope String Body 8 cobranca Escopo de Obrigatório

acesso. Passar para Grant
fixo Type
“cobranca”. password
SAÍDA:
Tipo de
Ord Nome Tipo Formatação Descrição
Parâmetro
Token de autenticação para ser
1 access_token String JSON 576 bits
utilizado
27/06/2022 Versão - 1.0 Página 10

2017-08-
2 token_type String JSON 09T08:53:11.679- Tipo do Token
03:00
Será utilizado para gerar um
novo access_token, sem a
3 refresh_token String JSON 636 dígitos necessidade de uma nova
autenticação com usuário e
senha
Tempo de expiração (em
4 expires_in String JSON 3 dígitos
segundos) do Access Token
Tempo de expiração (em
5 refresh_expires_in String JSON 6 dígitos
segundos) do Refresh Token
cobranca profile Escopo que o usuário possui
6 scope String JSON
email acesso.
RETORNO (Response):
Código Descrição
HTTP_OK (200) Operação realizada com sucesso
FALHAS:
Parâmetros de
Status Mensagem entrada Descrição
sujeitos a crítica
Ocorreu um erro
Erro quando o endereço
ao realizar
HTTP_NOT_FOUND (404) Não possui (URL) inválido. Deve-se
operação de
verificar a url utilizada.
autenticação.
Erros ocasionados por

username,
Invalid user username ou password não
HTTP_UNAUTHORIZED (401) password,
credentials informado ou
context
inválidos.
Missing
HTTP_UNAUTHORIZED Erro ocasionado por
parameter: username
(401) username não informado.
username
Could not find a
Erro ocasionado quando o
HTTP_UNAUTHORIZED required Access
x-api-key parâmetro x-api-key não foi
(401) Token in the
informado ou está inválido.
request,
27/06/2022 Versão - 1.0 Página 11

identified by
HEADER x-api-key

Missing form
parâmetro grant_type não é
HTTP_BAD_REQUEST (400) parameter: grant_type
informado ou
grant_type
inválido.
HTTP_GATEWAY_TIMEOUT serviço não conseguiu
Gateway Timeout Não se aplica
(504) responder no tempo
esperado.
REQUEST – POST:
URL Sandbox (ambiente para homologação):

https://api-parceiro.sicredi.com.br/sb/auth/openapi/token
OBS: Para validações no ambiente Sandbox, utilizar os seguintes valores para os campos “username” e
“password”:
username : 123456789
password: teste123
URL Produção:
https://api-parceiro.sicredi.com.br/auth/openapi/token
RESPONSE:
{
"access_token":
"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJxMlRFLXliYWxnNjIxSmRCMU9IX0w2Sms5QllxODJtNkFS
Z0NGaDZtQnZBIn0.eyJleHAiOjE2NTY0NTA5MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiZjNiYjg5YzQtOGRmM
y00OTMxLWExOTItMjUxMjUxZWE1YzNkIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGk
uY2xvdWQvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjozMWY3ODE1MS1jMzdmLTQzO
WYtYTIwOS02NjFjYTQ3MzkzYTE6Q09CUkFOQ0E6MDA0MTQwMTE2IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoib3Bl
bmFwaS1ndy1zZW5zZWRpYSIsInNlc3Npb25fc3RhdGUiOiIwNGQ3YTAwYS05MjhiLTQ3NzQtYTY1MC1mOWQx
ODkzNWE3NDMiLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbImRlZmF1bHQtcm9sZXMtb3BlbmFwa
SIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW
50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbG
UiXX19LCJzY29wZSI6ImNvYnJhbmNhIHByb2ZpbGUgZW1haWwiLCJzaWQiOiIwNGQ3YTAwYS05MjhiLTQ3NzQ
tYTY1MC1mOWQxODkzNWE3NDMiLCJvcGVuYXBpX3VzZXJuYW1lIjoiMDA0MTQwMTE2Iiwib3BlbmFwaV9jb2
50ZXh0IjoiQ09CUkFOQ0EiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6IjAwNDE0M
DExNiJ9.mVzfyzBhVFwRWVnQkbiD00zitoOfmatRcDN_e_OKo4XKcOY6RU-qlpJ0FOC-
_7Qy5ez7XveNeRyq47ToY6F0skbw-0BswxY3qdQHBr50G-
27/06/2022 Versão - 1.0 Página 12

AxqICYLSUTEamrPc0vLNwADdPracL9P2W_EVEFLae7QeVzc0toNLjvaLJCaGZH6-
wV99qMjf0VUj5nRCUm6ZCllb3NioyI6mXsj0Ea1s8RdgnanWvgvD-
cNjmCmMXVhy7U_MScLIb_7cIrn4TbcbkA3r11b96KzU9cp5BCXHZysDdX0wRFVzQUQfBsf33E40GSNJ-
juFZdV86vWCmx7BjKnC1s3embfX0p-9JnbNUy7Q",
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token":
"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJhMTRlOTdmOC1lZmJiLTQ2YTYtOTYwYy0wNTFlZjA4MT
U3MjEifQ.eyJleHAiOjE2NTY0NTI0MzIsImlhdCI6MTY1NjQ1MDYzMiwianRpIjoiOWIyOWE3YjMtYzRhNS00NGQz
LTg3MjQtZWU4ZGQzYjIwNDAxIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLW9wZW5hcGkucHJkLnNpY3JlZGkuY2xvdW
QvcmVhbG1zL29wZW5hcGkiLCJhdWQiOiJodHRwczovL2F1dGgtb3BlbmFwaS5wcmQuc2ljcmVkaS5jbG91ZC9y
ZWFsbXMvb3BlbmFwaSIsInN1YiI6ImY6MzFmNzgxNTEtYzM3Zi00MzlmLWEyMDktNjYxY2E0NzM5M2ExOkNP
QlJBTkNBOjAwNDE0MDExNiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJvcGVuYXBpLWd3LXNlbnNlZGlhIiwic2Vzc2lvbl9z
dGF0ZSI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyIsInNjb3BlIjoiY29icmFuY2EgcHJvZ
mlsZSBlbWFpbCIsInNpZCI6IjA0ZDdhMDBhLTkyOGItNDc3NC1hNjUwLWY5ZDE4OTM1YTc0MyJ9.Om0gACw3fK
yfSnWyNhlElQSMYYtClCHrZYdGAIc4ul0",
"token_type": "Bearer",
"not-before-policy": 0,
"session_state": "04d7a00a-928b-4774-a650-f9d18935a743",
"scope": "cobranca profile email"
}
Execução (via ferramenta Postman)

▪ Cenário Positivo – Gerando o access_token
27/06/2022 Versão - 1.0 Página 13

OBS: Sempre verificar o tempo de expiração do access_token, através do campo “expires_in” (Exemplo: 300
segundos). Caso esteja expirado, deverá usar o refresh_token para gerar um novo token.
▪ Cenário Positivo – Utilizando o refresh_token para gerar um novo token
27/06/2022 Versão - 1.0 Página 14

OBS: Sempre verificar o tempo de expiração do refresh_token, através do campo “refresh_expires_in”

(Exemplo: 1800 segundos). Caso esteja expirado, deverá gerar um novo access_token. Quando da utilização
do refresh_token, não será necessário informar os campos “username” e “password”.
▪ Cenário de Erro <400 - BAD_REQUEST>
27/06/2022 Versão - 1.0 Página 15

▪ Cenários de Erro <401 - UNATHORIZED>
27/06/2022 Versão - 1.0 Página 16

7.2. Cadastro de Boletos

A operação POST “criar” é responsável pela geração de boletos individuais de Cobrança
(Tradicional ou Híbrido). O formato de entrada e saída é JSON, considerando que a saída sempre é
composta da entidade a ser retornada e um código HTTP dentro de um Response. O tipo de codificação
utilizado no Response é Unicode UTF-8. Por padrão o recurso cadastro responde em milissegundos.
27/06/2022 Versão - 1.0 Página 17

ENTRADA:
Parametr
o
Access token
Header
1 x-api-key String 38 UUID gerado no portal Obrigatório
Param
do desenvolvedor
Campo
access_token
Header Bearer + Token
2 Authorization String 1413 obtido na Obrigatório
Param de Autenticação
saída da
autenticação.
Estabelece o
Application/js Header Sem tipo de
3 Content-Type
on param formatação conteúdo da
requisição
Header Sem Código da
3 cooperativa String 4 Obrigatório
Param formatação Cooperativa -
Header Sem Código da
4 posto String 2 Obrigatório
Param formatação Agência
Indica o tipo de
cobrança do
Domínios: boleto, podendo
5 tipoCobranca String Body 7 NORMAL ou ser: NORMAL Obrigatório
HIBRIDO (Tradicional, sem
QRCode) ou
Híbrido
Código do
codigoBenefici Sem
6 String Body 5 Convênio de Obrigatório
ario formatação
Cobrança
Informações do
7 pagador Objeto Body Obrigatório
Pagador
Domínios:
PESSOA_JURIDI Tipo de pessoa
8 tipoPessoa String Body 15 Obrigatório
CA ou do Pagador
PESSOA_FISICA
CPF ou CNPJ do
Sem
9 documento String Body 14 Pagador do Obrigatório
formatação
boleto
Sem Nome do
10 nome String Body 40 Obrigatório
formatação Pagador
27/06/2022 Versão - 1.0 Página 18

Opcional
(obrigatório se o
Sem Endereço do cadastro do
11 endereco String Body 40
formatação Pagador beneficiário está
configurado para
validar cep)
Opcional
(obrigatório se o
Sem Cidade do cadastro do
12 cidade String Body 25
formatação Pagador beneficiário está
configurado para
validar cep)
Opcional
(obrigatório se o
Sem cadastro do
13 uf String Body 2 UF do Pagador
formatação beneficiário está
configurado para
validar cep)
Opcional
(obrigatório se o
cadastro do
14 cep String Body 8 0-9 CEP do Pagador
beneficiário está
configurado para
validar cep)
Telefone do
15 telefone String Body 11 0-9 Opcional
Pagador
Email do
16 email String Body 40 xxx@xx.xx Opcional
Pagador
Informações do
beneficiarioFin
17 Objeto Body Beneficiário Final Opcional
al
(Avalista)
Sem CPF/CNPJ do
18 documento String Body 14 Obrigatório
Formatação Beneficiário Final
Domínios:
PESSOA_JURIDI
19 tipoPessoa String Body 15 Tipo de Pessoa Obrigatório
CA ou
PESSOA_FISICA
Sem Nome do
20 nome String Body 40 Obrigatório
formatação Beneficiário Final
Sem Logradouro do
21 logradouro String Body 40 Opcional
27/06/2022 Versão - 1.0 Página 19

Complemento
Sem
22 complemento String Body 40 do Beneficiário Opcional
formatação
Final
Número do
numeroEndere Sem
23 String Body 20 endereço do Opcional
co formatação
Beneficiário Final
Sem Cidade do
24 cidade String Body 25 Opcional
Sem UF do
25 uf String Body 2 Opcional
CEP do
26 cep String Body 8 0-9 Opcional
Beneficiário Final
Telefone do
27 telefone String Body 11 0-9 Opcional
Beneficiário Final
Email do
28 email String Body 40 xxx@xx.xx Opcional
Beneficiário Final
Domínios: Espécie de
documento do
DUPLICATA_MER título, podendo
CANTIL_INDICAC
ser:
AO
DUPLICATA_RUR A - DUPLICATA
AL MERCANTIL
INDICAÇÃO
NOTA_PROMISSO
RIA B - DUPLICATA
RURAL
NOTA_PROMISSO
RIA_RURAL C - NOTA
PROMISSO
especieDocum RIA
29 String Body 29 NOTA_SEGUROS Obrigatório
ento
RECIBO D - NOTA
PROMISSO
LETRA_CAMBIO RIA RURAL
NOTA_DEBITO E - NOTA
DE
DUPLICATA_SERV SEGUROS
ICO_INDICACAO
G – RECIBO
OUTROS
BOLETO_PROPOS H - LETRA
TA DE CAMBIO
27/06/2022 Versão - 1.0 Página 20

CARTAO_CREDIT I - NOTA DE
O DÉBITO
J - DUPLICATA DE
SERVICO
INDICAÇÃO
K – OUTROS
O - BOLETO
PROPOSTA
P - CARTÃO DE
CRÉDITO
Opcional. Caso o
beneficiário não
Sem
30 nossoNumero String Body 9 Nosso número informe, o Sicredi
formatação
gera
automaticamente.
Número de
controle interno
Sem
31 seuNumero String Body 10 do beneficiário Obrigatório
formatação
que faz referência
ao pagador.
Data de
dataVenciment
32 Date Body 10 YYYY-MM-DD vencimento do Obrigatório
o
boleto
Quantidade de
Opcional. Não
dias, após o
poderá ser
vencimento, em
informado, caso o
diasProtestoAu Sem que será
33 Integer Body 2 campo
to formatação realizado o
“diasNegativacaoAu
protesto
to” esteja
automático do
preenchido
boleto
Quantidade de
Opcional. Não
dias, após o
poderá ser
vencimento, em
diasNegativaca Sem informado, caso o
34 Integer Body 2 que o boleto será
oAuto formatação campo
negativado
“diasProtestoAuto”
automaticamente
esteja preenchido
.
Quantidade de Opcional. Caso não
validadeAposV Sem
35 Integer Body 4 dias que o QR informado, será
encimento formatação
Code continuará preenchido com o
27/06/2022 Versão - 1.0 Página 21

válido após o valor contido no

vencimento, caso campo de
seja um boleto quantidade de dias
híbrido. de baixa
automática
existente no
cadastro do
beneficiário
Obrigatório. (Caso
seja tipo de boleto
NORMAL
Sem (Tradicional) e
36 valor number Body 14,2 Valor do boleto
formatação espécie Boleto
Proposta pode ser
informado 0,00)
Tipo de
Domínios: desconto
37 tipoDesconto String Body 10 VALOR ou podendo ser: Opcional
PERCENTUAL A - VALOR
B - PERCENTUAL
Opcional. Será
obrigatório se o
campo
dataDesconto1 for
valorDesconto Sem Valor de informado. Não
38 number Body 14,2
1 formatação desconto 1 deverá ser
informado caso o
desconto
antecipado esteja
preenchido
Opcional. Será
obrigatório se o
campo
valorDesconto1 for
informado. Não
Data limite para pode ser igual as
39 dataDesconto1 Date Body 10 YYYY-MM-DD concessão de outras datas de
desconto1 desconto e nem
maior que
vencimento. Não
deverá ser
informado caso o
desconto
27/06/2022 Versão - 1.0 Página 22

antecipado esteja
preenchido
Opcional. Será
obrigatório se o
campo
dataDesconto2 for
40 number Body 14,2
informado caso o
desconto
antecipado esteja
preenchido
Opcional. Será
obrigatório se o
campo
valorDesconto2 for
informado. Não
pode ser igual as
Data limite para a outras datas de
41 dataDesconto2 Date Body 10 YYYY-MM-DD concessão de desconto e nem
desconto 2 maior que
vencimento. Não
deverá ser
informado caso o
desconto
antecipado esteja
preenchido
Opcional. Será
obrigatório se o
campo
dataDesconto3 for
42 number Body 14,2
informado caso o
desconto
antecipado esteja
preenchido
27/06/2022 Versão - 1.0 Página 23

Opcional. Será
obrigatório se o
campo
valorDesconto3 for
informado. Não
pode ser igual as
Data limite para a outras datas de
43 dataDesconto3 Date Body 10 YYYY-MM-DD concessão de desconto e nem
desconto 3 maior que
vencimento. Não
deverá ser
informado caso o
desconto
antecipado esteja
preenchido
Opcional. Não
Valor de deverá ser
descontoAnteci Sem
44 number Body 14,2 Desconto informado caso o
pado formatação
Antecipado desconto normal
esteja preenchido
Tipo de
Domínios: Juros,
45 tipoJuros String Body 10 VALOR ou podendo ser: Opcional
PERCENTUAL A - VALOR
B - PERCENTUAL
Sem Valor de juros a
46 juros number Body 14,2 Opcional
formatação cobrar por dia
Sem Percentual de
47 multa number Body 5,2 Opcional
formatação multa a cobrar
Permitido
informar uma
lista de até 5
Sem
48 informativo List<String> Body 400 informativos, com Opcional
formatação
limite de 80
caracteres para
cada.
Permitido
informar uma
lista de até 4
Sem
49 mensagem List<String> Body 320 mensagens, com Opcional
formatação
limite de 80
caracteres para
cada
SAÍDA:
27/06/2022 Versão - 1.0 Página 24

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 Sem formatação Código de Barras
5 cooperativa String 4 Sem formatação Código da Cooperativa do Beneficiário
6 posto String 2 Sem formatação Código da Agência do Beneficiário
7 nossoNumero String 9 Sem formatação Nosso Número
RETORNO (Response):
Status Descrição
HTTP_ACCEPTED (201) Operação aceita com sucesso
FALHAS:
Parâmetros
Status Mensagem sujeitos à Descrição
crítica
Ocorreu um
erro ao
HTTP_NOT_FOUND (404) realizar Não possui Erro ocasionado por URL inválida.
operação de
cadastro
Erro ocasionado por parâmetro
Tipo de
HTTP_UNSUPPORTED_MEDIA Parâmetro: obrigatório não informado ou
conteúdo não
_TYPE (415) Content-Type inválido.
suportado
Parâmetro:
HTTP_UNAUTHORIZED (401) Unauthorized obrigatório não informado ou
Authorization
inválido.
27/06/2022 Versão - 1.0 Página 25

Cooperativa Erro ocasionado quando o código de

HTTP_UNAUTHORIZED diferente da Parâmetro: cooperativa informado no cadastro
(401) cooperativa do cooperativa for diferente do contido na
usuário autenticação.
Código de
Erro ocasionado quando o código de
beneficiário Parâmetro:
HTTP_UNAUTHORIZED beneficiário informado no cadastro
diferente do codigoBenefici
(401) for diferente do contido na
beneficiário do ario
autenticação.
usuário
Qualquer
parâmetro que
consta como
Campo Erros ocasionados por parâmetros
obrigatório na
HTTP_BAD_REQUEST (400) obrigatório em obrigatórios não informados ou
listagem de
branco inválidos.
parâmetros de
entrada pode
ser criticado
O campo
cooperativa
deve ser Erros ocasionados por parâmetros
Parâmetro:
HTTP_BAD_REQUEST (400) preenchido obrigatórios não preenchidos ou
cooperativa
com 4 (quatro) inválidos.
caracteres
numéricos.
O campo
posto deve ser Erros ocasionados por parâmetros
Parâmetro:
HTTP_BAD_REQUEST (400) preenchido obrigatórios não preenchidos ou
posto
com 2 (dois) inválidos
caracteres.
O campo tipo
HTTP_BAD_REQUEST (400) cobrança deve Parâmetro:
obrigatório não informado ou
ser HíBRIDO tipoCobranca
inválido.
ou NORMAL
O campo
código do
beneficiario Parâmetro: Erro ocasionado por parâmetro
HTTP_BAD_REQUEST (400)
deve ter 5 codigoBenefici obrigatório não informado ou
(cinco) ario inválido.
caracteres
numéricos.
27/06/2022 Versão - 1.0 Página 26

A data de
vencimento do
Parâmetro: Erro ocasionado por parâmetro
boleto é
HTTP_BAD_REQUEST (400) dataVencimen obrigatório não preenchido ou
obrigatória e
to inválido.
deve ser
preenchida.
Os dias de
protesto
Parâmetro:
HTTP_BAD_REQUEST (400) automático do O campo "diasProtestoAuto" não foi
diasProtestoA
boleto deve preenchido com valores entre 3 e 99.
uto
ter entre 3 e
99 dias.
O valor de
juros do
O campo "juros" foi preenchido com
HTTP_BAD_REQUEST (400) boleto deve Parâmetro:
um valor igual ou menor que zero.
ser superior a juros
zero, ou não
informado.
O valor de
multa do
O campo "multa" foi preenchido com
HTTP_BAD_REQUEST (400) boleto deve Parâmetro:
ser superior a multa
zero, ou não
informado.
O valor do
primeiro
desconto do Parâmetro: O campo "valorDesconto1" foi
boleto deve valorDesconto preenchido com um valor igual ou
ser superior a 1 menor que zero.
zero, ou não
informado.
O valor do
segundo
zero, ou não
informado.
O valor do
terceiro
zero, ou não
informado.
27/06/2022 Versão - 1.0 Página 27

O valor de
desconto
O campo "descontoAntecipado" foi
antecipado do Parâmetro:
HTTP_BAD_REQUEST (400) preenchido com um valor igual ou
boleto deve descontoAntec
menor que zero.
ser superior a ipado
zero, ou não
informado.
O campo
documento do O campo "documento" (CPF/CNPJ)
HTTP_BAD_REQUEST (400) Parâmetro:
beneficiário do beneficiário final foi preenchido
documento
final está de forma inválida.
inválido.
O nome do
beneficiário O campo "nome" do beneficiário
final permite final foi preenchido com mais de 40
nome
até 40 caracteres.
caracteres.
O e-mail do
beneficiário O campo "email" do beneficiário
final permite final foi preenchido com mais de 40
email
até 40 caracteres.
caracteres.
O nome do
HTTP_BAD_REQUEST (400) Parâmetro: O campo "nome" do pagador não foi
pagador é
nome informado.
obrigatório.
O nome do
O campo "nome" do pagador foi
HTTP_BAD_REQUEST (400) pagador Parâmetro:
preenchido com mais de 40
permite até 40 nome
caracteres.
caracteres.
O campo "documento" do pagador
O campo
(CPF/CNPJ) foi preenchido de forma
HTTP_BAD_REQUEST (400) documento do Parâmetro:
inválida. Deve conter entre 11 e 14
pagador está documento
posições.
inválido.
27/06/2022 Versão - 1.0 Página 28

Negócio:
Beneficiário:
XXXXXXXXXXX
XXX não tem
O beneficiário não possui o produto
HTTP_UNPROCESSABLE_ENTIT contratado o
Não possui Cobrança Online contratado.
Y (422) serviço de
Cobrança
Online
(ECOMM).
Negócio:
Beneficiário:
XXXXXXXXXXX
XXX esta com
O cadastro do beneficiário está
HTTP_UNPROCESSABLE_ENTIT o status de
Não possui encerrado. Necessário verificar com
Y (422) convenio
a cooperativa.
encerrado.
Verificar status
com a
cooperativa.
Negócio: O campo tipoCobranca foi
Híbrido não preenchido como "HIBRIDO".
HTTP_UNPROCESSABLE_ENTIT
contratado. Não possui Entretanto, o beneficiário não possui
Y (422)
Favor solicitar o produto Pix contratado. Necessário
a contratação. contatar a cooperativa.
Negócio:
Documento do
pagador não
pode ser o
Parâmetros:
mesmo do O campo "documento", tanto do
HTTP_UNPROCESSABLE_ENTIT documento
beneficiário pagador, quanto do beneficiário
Y (422) (pagador e
final para final, foram preenchidos com o
beneficiario
espécie de mesmo CPF/CNPJ.
final)
documento
DUPLICATA_M
ERCANTIL_IND
ICACA"
Negócio:
Documento do
HTTP_UNPROCESSABLE_ENTIT Parâmetro: O campo "documento" do pagador
Beneficiário
Y (422) documento foi preenchido com o mesmo
não pode ser o
(pagador) CPF/CNPJ do beneficiário.
mesmo do
Pagador.
Negócio:
HTTP_UNPROCESSABLE_ENTIT Não foram informados os dados do
Tí-tulo com Parâmetro:
Y (422) beneficiário final.
Protesto
27/06/2022 Versão - 1.0 Página 29

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

O campo "valor" foi preenchido com

Negócio: Valor
do titulo deve
Só poderá ser preenchido com valor
ser maior que
HTTP_UNPROCESSABLE_ENTIT igual a zero caso a espécie do boleto
zero para Parâmetro:
Y (422) seja:
espécie valor
DUPLICATA_M
- Boleto Proposta
ERCANTIL_IND
- Cartão de Crédito
ICACAO
Negócio: Não
permite juros
maior ou igual
ao valor do
HTTP_UNPROCESSABLE_ENTIT O campo "juros" foi preenchido com
titulo para Parâmetro:
Y (422) um valor maior ou igual ao valor do
Espécie de juros
título.
documento
DUPLICATA_M
ERCANTIL_IND
ICACAO
Negócio:
HTTP_UNPROCESSABLE_ENTIT Percentual
Parâmetro: O percentual de juros informado foi
Y (422) juros deve ser
juros maior ou igual a 100%.
menor que
100%
Negócio: O
valor da multa
aplicada
R$ X.XXXXXX
não pode ser
menor que
R$ 0,01.
Exemplo: Se o
O campo "multa" (percentual) foi
HTTP_UNPROCESSABLE_ENTIT valor do título
Parâmetro: preenchido com um valor muito
Y (422) for de R$ 5,00
multa baixo, fazendo com que o cálculo da
e a multa for
multa seja inferior a R$ 0,01.
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.
Negócio: O Parâmetro: O campo "valorDesconto1" foi
HTTP_UNPROCESSABLE_ENTIT
valor de valorDesconto preenchido com um valor maior ou
Y (422)
Desconto 1 1 igual ao título.
27/06/2022 Versão - 1.0 Página 31

HTTP_UNPROCESSABLE_ENTIT deve ser

Y (422) menor que o
valor do
boleto.
Negócio: O
valor de
O campo "valorDesconto2" foi
HTTP_UNPROCESSABLE_ENTIT Desconto 2 Parâmetro:
preenchido com um valor maior ou
Y (422) deve ser valorDesconto
igual ao título.
menor que o 2
valor do
boleto.
Negócio: O
valor de
O campo "valorDesconto3" foi
HTTP_UNPROCESSABLE_ENTIT Desconto 3 Parâmetro:
preenchido com um valor maior ou
Y (422) deve ser valorDesconto
igual ao título.
menor que o 3
valor do
boleto.
Negócio:
Percentual O percentual do desconto 1 foi
desconto 1 preenchido com um valor maior ou
Y (422) valorDesconto
invalido: deve igual a 100%.
1
ser menor que
100%
Negócio:
2
ser menor que
100%
Negócio:
3
ser menor que
100%
Negócio: Data
O campo "dataDesconto1" foi
HTTP_UNPROCESSABLE_ENTIT de desconto 1 Parâmetro:
preenchido com uma data retroativa,
Y (422) não deve ser dataDesconto
ou seja, menor que a data atual.
menor que 1
data atual.
Negócio: Data
menor que 2
data atual.
27/06/2022 Versão - 1.0 Página 32

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

documento:
XXXXXXXXXXX
Negócio: CEP
do pagador
esta inválido
HTTP_UNPROCESSABLE_ENTIT Parâmetro: O campo "cep" do pagador foi
com protesto
Y (422) cep preenchido com um cep inválido.
ou
negativação
automática
Negócio:
Beneficiário:
XXXXXXXXXXX
XXX esta
parametrizado
HTTP_UNPROCESSABLE_ENTIT como Terceiro Não foram informados os dados do
Y (422) Habilitado, beneficiário final.
deve ser
enviado
informações
do beneficiário
final.
Negócio: Não
permitido
O campo "tipoCobranca" foi
gerar QR Code
preenchido como "HIBRIDO".
para
HTTP_UNPROCESSABLE_ENTIT Parâmetro: Entretanto, quando o cadastro do
beneficiário
Y (422) tipoCobranca beneficiário está configurado para
que edita
permitir editar o valor, não é possível
valor. Favor
cadastrar boleto híbrido.
solicitar boleto
normal.
Negócio:
O campo "diasNegativacaoAuto" foi
Beneficiário
HTTP_UNPROCESSABLE_ENTIT Parâmetro: preenchido. Entretanto, o cadastro
sem permissão
Y (422) diasNegativaca do beneficiário não possui o produto
para cadastro
oAuto Serasa ativo.
com
negativação
Negócio:
HTTP_UNPROCESSABLE_ENTIT Beneficiário O beneficiário final está com o status
Y (422) final com Não se aplica de inapto.
situação
inapto.
REQUEST – POST:
27/06/2022 Versão - 1.0 Página 34

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
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):

{
"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",
27/06/2022 Versão - 1.0 Página 35

"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",
"tipoJuros": "VALOR",
"juros": 5.00,
"multa": 3.00,
"informativos": [
"info 1",
"info 2",
"info 3",
"info 4",
"info 5"
],
"mensagens": [
"mens 1",
"mens 2",
"mens 3",
"mens 4"
]
}
RESPONSE BODY (JSON):

{
"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"
}
27/06/2022 Versão - 1.0 Página 36


▪ Cenário Positivo:
▪ Cenário de erro <BAD_REQUEST>
27/06/2022 Versão - 1.0 Página 37

7.3. Impressão de Boletos

A operação GET “Geração de Boleto em Formato PDF” é responsável pela impressão e reimpressão
(2ª via) dos boletos de Cobrança em formato PDF. O formato de entrada é sempre JSON. Já o formato de
saída será arquivo binário (octet-stream), em caso de sucesso, e JSON, em caso de falha.
Entrada:
Tipo de
Parâmetro
1 x-api-key String HeaderParam 36 UUID Token de acesso Obrigatório

fornecido pelo
Sicredi
2 authorization String HeaderParam 1413 Bearer + Token de Acess token obtido Obrigatório
Autenticação na autenticação
3 linhaDigitavel String QueryParam 47 Sem formatação Código da linha Obrigatório

digitável do boleto.
Saída: Boleto em formato PDF, no formato binário
Para salvar o boleto, via postman, deverá clicar na opção “Download”
27/06/2022 Versão - 1.0 Página 38

RETORNO (Response):
Status Descrição
HTTP_CREATED (201) Operação criada com sucesso
FALHAS:
Parâmetros de
sujeitos a crítica
HTTP_UNAUTHORIZED (401) Could not find a Parâmetro: Erros ocasionados por
required Access x-api-key parâmetros obrigatórios
Token in the não informados ou
request, identified inválidos.
by HEADER x-api-
key
HTTP_UNAUTHORIZED (401) UNAUTHORIZED Parâmetro: Erros ocasionados por
Authorization parâmetros obrigatórios
não informados ou
inválidos.
27/06/2022 Versão - 1.0 Página 39

HTTP_UNAUTHORIZED (401) Código de Parâmetro: Erro ocasionado quando a

beneficiário linhaDigitavel linha digitável informada
diferente do é de beneficiário e/ou
beneficiário do agência diferente.
usuário
HTTP_BAD_REQUEST (400) A linha digitavel Parâmetro: Erros ocasionados por

deve ter 47 dígitos. linhaDigitavel parâmetros obrigatórios
não informados ou
inválidos.
HTTP_UNPROCESSABLE_ENTITY Boleto não Parâmetro: Erro ocasionado quando

(422) localizado. Verifique linhaDigitavel o boleto não é localizado
os dados informados através da linha digitável
ou entre em contato informada.
com o Beneficiário.
HTTP_TOO_MANY_REQUESTS (429) Too many requests Erro ocasionado quando

são enviadas muitas
requisições em um
determinado período de
tempo.
REQUEST – GET:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/pdf
URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/pdf
HEADERS:
Authorization
x-api-key
PARAM:
LinhaDigitavel
27/06/2022 Versão - 1.0 Página 40


▪ Parâmetros:
▪ Headers:
27/06/2022 Versão - 1.0 Página 41

▪ Cenário Negativo: 400 – BAD_REQUEST
▪ Cenário Negativo: 401 – UNAUTHORIZED
27/06/2022 Versão - 1.0 Página 42

▪ Cenário Negativo: 422 – UNPROCESSABLE_ENTITY
7.4. Comando de Instrução - Pedido de Baixa

A operação PATCH “Geração de baixa para boletos” é responsável por realizar a instrução de baixa
do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é composta da
entidade a ser retornada e um código HTTP dentro de um Response. O tipo de codificação utilizado no
Response é Unicode UTF-8. Por padrão o recurso cadastro responde em milissegundos.
Entrada:
Tipo de
Obrigató
Ord Nome Tipo Parâmetro Formatação Descrição
Tamanho rio
1 x-api-key String HeaderPar 36 UUID Token de Obrigatór

am acesso io
fornecido pelo
Sicredi
2 authorization String Header 1413 Bearer + Acess token Obrigatór
Token de obtido na io
Autenticação autenticação
3 Content-Type application/jso Header Sem Tipo conteúdo Obrigatór
n formatação io
4 cooperativa String Header 4 Sem Código da Obrigatór
formatação cooperativa do io
beneficiário
27/06/2022 Versão - 1.0 Página 43

5 Posto String Header 2 Sem Código da Obrigatór

formatação agência do io
beneficiário
6 codigoBeneficiario String Header 5 Sem Código do Obrigatór
formatação beneficiário io
7 nossoNumero String Patch 9 Sem Nosso Número Obrigatór
formatação io
Saída:
1 transactionId string 36 Sem Identificador da transação

formatação
2 dataMovimento String 10 Sem Data da instrução
formatação
3 codigoBeneficiario String 5 Sem Código do beneficiário
formatação
4 nossoNumero String 9 Sem Nosso Número
formatação
5 cooperativa String 4 Sem Código da cooperativa do
formatação beneficiário
6 posto String 2 Sem Código da agência do
7 statusComando String 17 Sem Status da operação gerada, que
formatação será:
- MOVIMENTO_ENVIADO
8 dataHoraRegistro String (date- 26 Sem Data e hora da instrução
time) formatação
9 tipoMensagem String 5 Sem Tipo de instrução, que será:
formatação
BAIXA
RETORNO (Response):
Status Descrição
HTTP_ACCEPTED (202) Operação recebida com sucesso
FALHAS:
27/06/2022 Versão - 1.0 Página 44

Parâmetros de
sujeitos a crítica
HTTP_UNAUTHORIZED (401) Could not find a Parâmetro: Erros ocasionados por
required Access x-api-key parâmetros obrigatórios
Token in the não informados ou
request, identified inválidos.
by HEADER x-api-
key
HTTP_UNAUTHORIZED (401) UNAUTHORIZED Parâmetro: Erro ocasionado quando o
Authorization parâmetro não foi
informado ou está inválido.
HTTP_UNAUTHORIZED (401) Código de Parâmetro: Erro ocasionado quando o

beneficiário codigoBeneficiario código de beneficiário
diferente do informado é diferente do
beneficiário do beneficiário contido no
usuário token de autenticação
(authorization).
HTTP_UNAUTHORIZED (401) Cooperativa Parâmetro: Erro ocasionado quando a
diferente da Cooperativa cooperativa informada é
cooperativa do diferente da cooperativa
usuário contida no token de
autenticação
(authorization).
HTTP_BAD_REQUEST (400) Título não Parâmetro: Erro ocasionado quando o
encontrado nossoNumero nosso número informado
não foi encontrado.
HTTP_UNPROCESSABLE_ENTITY Operação não Não se aplica Erro ocasionado quando o
(422) permitida: Título título está aguardando
aguardando confirmação de entrada.
confirmação.
(422) permitida: Título título está rejeitado.
rejeitado.
(422) permitida: Título já título está baixado.
baixado.
(422) permitida: Título já título está liquidado.
liquidado.
27/06/2022 Versão - 1.0 Página 45


(422) permitida: Título título está em fluxo de
em fluxo de negativação/protesto.
negativação ou
protesto.
HTTP_UNPROCESSABLE_ENTITY Sua solicitação Não se aplica Erro ocasionado quando é
(422) anterior está em realizada uma nova
processamento, tentativa de instrução para
aguarde alguns um boleto que está com a
instantes. solicitação anterior em
processamento.
HTTP_TOO_MANY_REQUESTS (429) Too many requests Não se aplica Erro ocasionado quando
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}/baixa
cooperativa : 6789
posto: 03
URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/baixa
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
{}
27/06/2022 Versão - 1.0 Página 46

PATCH:
nossoNumero

▪ HEADERS:
▪ BODY:
OBS: O body permanece vazio, conforme imagem acima.
27/06/2022 Versão - 1.0 Página 47

27/06/2022 Versão - 1.0 Página 48

27/06/2022 Versão - 1.0 Página 49

7.5. Comando de Instrução - Alteração de

Vencimento
A operação PATCH “Alteração de vencimento” é responsável por realizar a instrução de alteração
de vencimento do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é
Entrada:
Tipo
de Tamanho Obrigat
Parâme ório
tro
1 x-api-key String Header 36 UUID Token de Obrigat
Param acesso ório
fornecido pelo
Sicredi
2 authorization String Header 1413 Bearer + Token de Acess token Obrigat
Autenticação obtido na ório
autenticação
3 Content-Type application/ Header Sem formatação Tipo conteúdo Obrigat
json ório
4 cooperativa String Header 4 Sem formatação Código da Obrigat
cooperativa do ório
beneficiário
27/06/2022 Versão - 1.0 Página 50

5 Posto String Header 2 Sem formatação Código da Obrigat

agência do ório
beneficiário
6 codigoBeneficiario String Header 5 Sem formatação Código do Obrigat
beneficiário ório
7 dataVencimento String Body 10 YYYY-MM-DD Data de Obrigat
(date) vencimento do ório
boleto
8 nossoNumero String Patch 9 Sem formatação Nosso Número Obrigat
ório
Saída:
Ord Nome Tipo Tam Formatação Descrição

formatação
formatação

formatação

formatação



formatação será:
- MOVIMENTO_ENVIADO
8 dataHoraRegistro String 26 Sem Data e hora da instrução
(date-time) formatação
27/06/2022 Versão - 1.0 Página 51


formatação
ALTERA_VENCIMENTO
RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
HTTP_UNAUTHORIZED (401) Could not find a Parâmetro: Erros ocasionado por
required Access x-api-key parâmetro obrigatório não
Token in the informado ou inválido.
request, identified
by HEADER x-api-
key
HTTP_UNAUTHORIZED (401) UNAUTHORIZED Parâmetro: Erro ocasionado por
Authorization parâmetro obrigatório não
foi informado ou inválido.

(authorization).
27/06/2022 Versão - 1.0 Página 52


autenticação
(authorization).
HTTP_BAD_REQUEST (400) A data de Parâmetro: Erro ocasionado quando a
vencimento do dataVencimento data de vencimento não é
boleto é informada ou inválida.
obrigatória e deve
ser preenchida.
HTTP_UNPROCESSABLE_ENTITY Operação não Parâmetro: Erro ocasionado quando a

(422) permitida: dataVencimento data de vencimento
Vencimento não informada é retroativa.
deve ser inferior a
DD/MM/YYYY.

confirmação.
rejeitado.
baixado.
liquidado.
negativação ou
protesto.
27/06/2022 Versão - 1.0 Página 53


processamento.
espaço de tempo.
REQUEST – PATCH:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/data-vencimento
cooperativa : 6789
posto: 03
URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/data-vencimento
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
{“dataVencimento”: “XXXX-MM-DD”}
PATCH:
nossoNumero
27/06/2022 Versão - 1.0 Página 54


▪ Headers:
▪ Body:
27/06/2022 Versão - 1.0 Página 55

27/06/2022 Versão - 1.0 Página 56

27/06/2022 Versão - 1.0 Página 57


Desconto
A operação PATCH “Alteração de desconto” é responsável por realizar a instrução de alteração do
valor/percentual de desconto do boleto. O formato de entrada e saída é JSON, considerando que a saída
codificação utilizado no Response é Unicode UTF-8. Por padrão o recurso cadastro responde em
milissegundos.
Entrada:
Tipo
de Tamanho Obrigat
Parâme ório
tro
Param acesso ório
fornecido pelo
Sicredi
autenticação
json ório
27/06/2022 Versão - 1.0 Página 58


beneficiário
agência do ório
beneficiário
beneficiário ório
ório
8 valorDesconto1 Number Body 14,2 Sem formatação Valor do Opcion

desconto 1. al
Deverá ser
informado ao
menos um dos
três descontos.
desconto 2. al
Deverá ser
informado ao
menos um dos
três descontos.
desconto 3. al
Deverá ser
informado ao
menos um dos
três descontos.
Saída:

formatação
formatação

formatação

formatação
27/06/2022 Versão - 1.0 Página 59




formatação será:
- MOVIMENTO_ENVIADO

formatação
ALTERA_VALOR_DESCONTO
RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
request, identified
by HEADER x-api-
key
27/06/2022 Versão - 1.0 Página 60



(authorization).
autenticação
(authorization).
HTTP_BAD_REQUEST (400) O valor do Parâmetro: Erro ocasionado quando o

primeiro desconto valorDesconto1 valor do primeiro desconto
do boleto deve ser está zerado (0.00).
superior a zero, ou
não informado.
HTTP_BAD_REQUEST (400) O valor do valorDesconto2 Erro ocasionado quando o
segundo desconto valor do segundo desconto
do boleto deve ser está zerado (0.00).
superior a zero, ou
não informado.
HTTP_BAD_REQUEST (400) O valor do terceiro valorDesconto3 Erro ocasionado quando o
desconto do boleto valor do terceiro desconto
deve ser superior a está zerado (0.00).
zero, ou não
informado.
HTTP_UNPROCESSABLE_ENTITY Operação não Não se aplica Erro ocasionado quando
(422) permitida: não é informado pelo
Necessário menos um dos três
informar pelo descontos.
menos um dos
descontos.
27/06/2022 Versão - 1.0 Página 61


confirmação.
rejeitado.
baixado.
liquidado.
negativação ou
protesto.

processamento.
espaço de tempo.
REQUEST – PATCH:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/desconto
cooperativa : 6789
posto: 03
27/06/2022 Versão - 1.0 Página 62

URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/desconto
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
"valorDesconto1": 0.00,
"valorDesconto2": 0.00,
"valorDesconto3": 0.00
PATCH:
nossoNumero

▪ Headers:
27/06/2022 Versão - 1.0 Página 63

▪ Body:
27/06/2022 Versão - 1.0 Página 64

27/06/2022 Versão - 1.0 Página 65

27/06/2022 Versão - 1.0 Página 66


Data de Desconto
A operação PATCH “Alteração de data de desconto” é responsável por realizar a instrução de
alteração da data de desconto do boleto. O formato de entrada e saída é JSON, considerando que a saída
milissegundos.
Entrada:
Tipo
de Tamanho Obrigat
Parâme ório
tro
Param acesso ório
fornecido pelo
Sicredi
autenticação
json ório
beneficiário
27/06/2022 Versão - 1.0 Página 67


agência do ório
beneficiário
beneficiário ório
ório
8 data1 String (date) Body 10 YYYY-MM-DD Data do Opcion

desconto 1. al
Deverá ser
informado ao
menos uma
das três datas.
desconto 2. al
Deverá ser
informado ao
menos uma
das três datas.
desconto 3. al
Deverá ser
informado ao
menos uma
das três datas.
Saída:

formatação

formatação

formatação

formatação

27/06/2022 Versão - 1.0 Página 68



formatação será:
- MOVIMENTO_ENVIADO

formatação
ALTERA_DATA_DESCONTO
RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
request, identified
by HEADER x-api-
key

(authorization).
27/06/2022 Versão - 1.0 Página 69


autenticação
(authorization).
HTTP_UNPROCESSABLE_ENTITY Operação não Não se aplica Erro ocasionado quando

(422) permitida: não é informado ao menos
Necessário uma das três datas de
informar pelo desconto.
menos um dos
descontos.
(422) permitida: A data data2 data de desconto 2 é
de desconto 2 deve anterior à data de desconto
ser posterior a data 1.
de desconto 1.
(422) permitida: A data data3 data de desconto 3 é
de desconto 3 deve anterior à data de desconto
ser posterior a data 2.
de desconto 2.
confirmação.
rejeitado.
baixado.
liquidado.
27/06/2022 Versão - 1.0 Página 70


negativação ou
protesto.

processamento.
espaço de tempo.
REQUEST – PATCH:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/data-desconto
cooperativa : 6789
posto: 03
URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/data-desconto
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
27/06/2022 Versão - 1.0 Página 71

"data1": "YYYY-MM-DD",
"data2": "YYYY-MM-DD",
"data3": "YYYY-MM-DD"
PATCH:
nossoNumero

▪ Headers:
▪ Body:
27/06/2022 Versão - 1.0 Página 72

27/06/2022 Versão - 1.0 Página 73

27/06/2022 Versão - 1.0 Página 74


Juros
A operação PATCH “Alteração de juros” é responsável por realizar a instrução de alteração do
valor/percentual de juros do boleto. O formato de entrada e saída é JSON, considerando que a saída
milissegundos.
Entrada:
Tipo
de Tamanho Obrigat
Parâme ório
tro
Param acesso ório
fornecido pelo
Sicredi
autenticação
json ório
beneficiário
27/06/2022 Versão - 1.0 Página 75


agência do ório
beneficiário
beneficiário ório
ório
8 valorOuPercentual Number Body 14,2 Sem formatação Valor ou Obrigat

percentual de ório
juros do boleto
Saída:

formatação
formatação

formatação

formatação



formatação será:
- MOVIMENTO_ENVIADO

formatação
ALTERA_JUROS
27/06/2022 Versão - 1.0 Página 76

RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
request, identified
by HEADER x-api-
key

(authorization).
autenticação
(authorization).
HTTP_BAD_REQUEST (400) O valor ou Parâmetro: Erro ocasionado quando o

percentual é valorOuPercentual parâmetro não foi
obrigatório e deve informado.
ser preenchido.
27/06/2022 Versão - 1.0 Página 77


confirmação.
rejeitado.
baixado.
liquidado.
negativação ou
protesto.

processamento.
espaço de tempo.
REQUEST – PATCH:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/juros
cooperativa : 6789
posto: 03
27/06/2022 Versão - 1.0 Página 78

URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/juros
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
"valorOuPercentual": "0.00"
PATCH:
nossoNumero

▪ Headers:
27/06/2022 Versão - 1.0 Página 79

▪ Body:
27/06/2022 Versão - 1.0 Página 80

27/06/2022 Versão - 1.0 Página 81

7.9. Comando de Instrução - Alteração de Seu

Número
A operação PATCH “Alteração de seu número” é responsável por realizar a instrução de alteração
do Seu Número do boleto. O formato de entrada e saída é JSON, considerando que a saída sempre é
Entrada:
Tipo
de Tamanho Obrigat
Parâme ório
tro
27/06/2022 Versão - 1.0 Página 82


Param acesso ório
fornecido pelo
Sicredi
autenticação
json ório
beneficiário
agência do ório
beneficiário
beneficiário ório
ório
8 seuNumero String Body 10 Sem formatação Seu número Obrigat

do boleto. ório
Normalmente
usado neste
campo o
número da
nota fiscal
gerada para o
pagador.
Saída:

formatação
formatação

formatação

formatação
27/06/2022 Versão - 1.0 Página 83




formatação será:
- MOVIMENTO_ENVIADO

formatação
ALTERA_SEUNUMERO
RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
request, identified
by HEADER x-api-
key
27/06/2022 Versão - 1.0 Página 84


(authorization).
autenticação
(authorization).
HTTP_BAD_REQUEST (400) O campo seu Parâmetro: Erro ocasionado quando o

numero deve ter seuNumero parâmetro foi preenchido
entre 1 (um) e 10 com mais de 10 caracteres
(dez) caracteres. ou não foi informado.
confirmação.
rejeitado.
baixado.
liquidado.
negativação ou
protesto.
27/06/2022 Versão - 1.0 Página 85


processamento.
espaço de tempo.
REQUEST – PATCH:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/{nossoNumero}/seu-numero
cooperativa : 6789
posto: 03
URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos/{nossoNumero}/seu-numero
HEADERS:
Authorization
x-api-key
Cooperativa
posto
codigoBeneficiario
BODY:
"seuNumero": "0123456789"
PATCH:
27/06/2022 Versão - 1.0 Página 86

nossoNumero

▪ Headers:
▪ Body:
Cenário Positivo:
27/06/2022 Versão - 1.0 Página 87

27/06/2022 Versão - 1.0 Página 88

27/06/2022 Versão - 1.0 Página 89

7.10. Consulta de Boletos por Nosso Número

A operação GET “Consulta por Nosso Número” é responsável por realizar a consulta de um único
boleto, através do Nosso Número. O formato de entrada e saída é JSON, considerando que a saída sempre
é composta da entidade a ser retornada e um código HTTP dentro de um Response. O tipo de codificação
Entrada:
Tipo de
Tamanho
Ord Nome Tipo Parâmetro Formatação Descrição Obrigatório
1 x-api-key String Header 36 UUID Token de acesso Obrigatório

fornecido pelo
Sicredi
2 authorization String Header 1413 Bearer + Token Acess token Obrigatório

de Autenticação obtido na
autenticação
3 Content-Type application/ Header Sem formatação Tipo conteúdo Obrigatório
json
4 cooperativa String Header 4 Sem formatação Código da Obrigatório
cooperativa do
beneficiário
5 Posto String Header 2 Sem formatação Código da Obrigatório
agência do
beneficiário
6 codigoBeneficiario String Param 5 Sem formatação Código do Obrigatório
beneficiário
7 nossoNumero String Param 9 Sem formatação Nosso Número Obrigatório
Saída:

1 linhaDigitavel String 47 Sem formatação Linha digitável do
boleto
2 codigoBarras String 44 Sem formatação Código de barras do

boleto
27/06/2022 Versão - 1.0 Página 90

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 codigo String 5 Sem formatação Codigo do pagador
(Grupo com os
dados do documento String 14 Sem formatação Documento do
pagador) pagador
nome String 40 Sem formatação Nome do pagador
7 beneficiarioFinal codigo String 3 Sem formatação Código do

beneficiário final
(Grupo com os
dados do
beneficiário documento String 14 Sem formatação Documento do
final) beneficiário final
OBS: Caso não

nome String 40 Sem formatação Nome do
exista
beneficiário final
beneficiário final
vinculado ao
boleto, o grupo
não será exibido.
8 dataEmissao String (date) 10 YYYY-MM-DD Data de emissão 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
27/06/2022 Versão - 1.0 Página 91

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
- BAIXADO POR
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
16 tipoJuros String 14 Domínios: Tipo de juros do

A – VALOR boleto
B - PERCENTUAL
27/06/2022 Versão - 1.0 Página 92

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: Tipo de desconto do

boleto, podendo ser:
A – VALOR
B - PERCENTUAL A – VALOR
B - PERCENTUAL
22 descontoAntecipacao Number 14,2 Sem formatação Valor do desconto
antecipado do
boleto
23 descontos numeroOrdem Integer 1 Domínios: Número da ordem,

podendo ser:
(Lista com até 3 1
descontos) 2 1- Desconto 1
3 2- Desconto 2
Obs: Caso não 3- Desconto 3
exista desconto
cadastrado, a lista
retorna vazia: valorDesconto Bigdecimal 14,2 "valorDesconto": 0.0 Valor/percentual de
desconto
"descontos": []
dataLimite String(date) 10 "dataLimite": "YYYY- Data limite do

MM-DD" desconto
27/06/2022 Versão - 1.0 Página 93

24 dadosLiquidacao data String(date) YYYY-MM- Data e hora da

DD'T':HH:mm:ss.SSS'Z' liquidação do boleto
(Grupo que
retorna os valores
valor Bigdecimal 14,2 Sem formatação Valor da liquidação
de liquidação do
do boleto
boleto)
multa Bigdecimal 14,2 Sem formtação Valor da multa
OBS: Esse grupo cobrado na
só será exibido liquidação
caso o boleto
esteja liquidado. 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
RETORNO (Response):
Status Descrição
FALHAS:
Parâmetros de
sujeitos a crítica
request, identified
by HEADER x-api-
key
27/06/2022 Versão - 1.0 Página 94



(authorization).
autenticação
(authorization).
HTTP_NOT_FOUND (404) Titulo não Parâmetro: Erro ocasionado quando
encontrado nossoNumero não existe resultado para a
consulta informada.
HTTP_BAD_REQUEST (400) O campo nosso Parâmetro: Erro ocasionado quando o

numero deve ter nossoNumero parâmetro foi preenchido
apenas 9 (nove) com menos ou mais de 9
caracteres caracteres.
numéricos.
espaço de tempo.
REQUEST – GET:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos
“posto”, “codigoBeneficiario” e “nossoNumero”:
cooperativa : 6789
posto: 03
27/06/2022 Versão - 1.0 Página 95

URL Produção:
https://api-parceiro.sicredi.com.br/cobranca/boleto/v1/boletos
HEADERS:
Authorization
x-api-key
Cooperativa
posto
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",
"documento": "00000000000",
"nome": "COBRANCA TESTE"
},
"dataEmissao": "2022-08-25",
"dataVencimento": "2022-09-23",
27/06/2022 Versão - 1.0 Página 96

"valorNominal": 1,
"situacao": "EM CARTEIRA PIX",
"txId": "79031878967e4032a89c59eb3f232cda",
"codigoQrCode": " 00020126930014br.gov.bcb.pix2571pix-qrcode-
h.sicredi.com.br/qr/v2/cobv/528520acdd5f4740b63b9b643ca2bcf99999999999999999999BR5903PIX
6006Cidade62070503***630441AC",
"multa": 0,
"abatimento": 0,
"tipoJuros": "A - VALOR",
"juros": 0,
"diasProtesto": 0,
"validadeAposVencimento": 1,
"diasNegativacao": 0,
"tipoDesconto": "A - VALOR",
"descontoAntecipacao": 0,
"descontos": [
{
"numeroOrdem": 1,
"valorDesconto": 10,
"dataLimite": "2022-09-03"
},
{
"numeroOrdem": 2,
"valorDesconto": 8,
"dataLimite": "2022-09-05"
},
{
"numeroOrdem": 3,
"valorDesconto": 5,
27/06/2022 Versão - 1.0 Página 97

"dataLimite": "2022-09-07"
}
]
}
]
}

▪ Headers:
▪ Params:
27/06/2022 Versão - 1.0 Página 98

27/06/2022 Versão - 1.0 Página 99

7.11. Consulta de Boletos Liquidados por Dia

A operação GET “Consulta de Boletos Liquidados por Dia” é responsável por realizar a consulta de
boletos já liquidados, através de uma data específica. O formato de entrada e saída é JSON, considerando
que a saída sempre é composta da entidade a ser retornada e um código HTTP dentro de um Response.
O tipo de codificação utilizado no Response é Unicode UTF-8. Por padrão o recurso cadastro responde
em milissegundos.
Entrada:
Tipo de
Tamanho
Ord Nome Tipo Parâmetro Formatação Descrição Obrigatório
1 x-api-key String Header 36 UUID Token de acesso Obrigatório

fornecido pelo
Sicredi
2 authorization String Header 1413 Bearer + Token Acess token Obrigatório

de Autenticação obtido na
autenticação
3 Content-Type application/ Header Sem formatação Tipo conteúdo Obrigatório
x-www-
form-
urlencoded
4 cooperativa String Header 4 Sem formatação Código da Obrigatório
cooperativa do
beneficiário
27/06/2022 Versão - 1.0 Página 100

5 posto String Header 2 Sem formatação Código da Obrigatório

agência do
beneficiário
6 codigoBeneficiario String Param 5 Sem formatação Código do Obrigatório
beneficiário
7 dia String Param 10 DD/MM/YYYY Data em que o Obrigatório
boleto foi
liquidado
8 cpfCnpjBeneficiario String Param 14 Sem formatação CPF ou CNPJ do Opcional
Final beneficiário final
9 pagina Integer Param 2 Sem formatação Número da Opcional

página da
consulta
Saída:

1 items cooperativa String 4 Sem Cooperativa do beneficiário
formatação do boleto
2 codigoBeneficiario String 5 Sem Código do beneficiário do
formatação boleto
3 cooperativaPostoBeneficiario String 6 Sem Código da cooperativa e

formatação posto do beneficiário

formatação
5 seuNumero String 10 Sem Seu Número do boleto

formatação
6 tipoCarteira String 20 Sem Tipo de carteira, podendo

formatação ser:
- CARTEIRA_SIMPLES
- CARTEIRA_ CAUCIONADA
- CARTEIRA_DESCONTADA
- CARTEIRA_VINCULADA
7 dataPagamento String 10 YYYY-MM-DD Data da liquidação do
boleto
27/06/2022 Versão - 1.0 Página 101

8 valor Number 14,2 Sem Valor nominal do boleto

formatação
9 valorLiquidado Number 14,2 Sem Valor da liquidação do

formatação boleto
10 jurosLiquido Number 14,2 Sem Valor de juros do boleto

formatação liquidado
11 descontoLiquido Number 14,2 Sem Valor de desconto do

formatação boleto liquidado
12 multaLiquida Number 14,2 Sem Valor de multa do boleto

formatação liquidado
13 abatimentoLiquido Number 14,2 Sem Valor de abatimento do

formatação boleto liquidado
14 tipoLiquidacao String 23 Sem Tipo da liquidação,

formatação podendo ser:
- AVISO DE PAGAMENTO
REDE
- AVISO DE PAGAMENTO
COMPE
- REDE
- COMPE
- PIX
15 hasNext String 5 Sem Esse campo indica se
formatação 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):
Status Descrição
27/06/2022 Versão - 1.0 Página 102

FALHAS:
Parâmetros de entrada
Status Mensagem Descrição
sujeitos a crítica

required Access x-api-key parâmetro obrigatório
Token in the não informado ou
request, identified inválido.
by HEADER x-api-
key
Authorization parâmetro obrigatório
não foi informado ou
inválido.
HTTP_UNAUTHORIZED (401) Código de Parâmetro: Erro ocasionado quando

beneficiário codigoBeneficiario o código de beneficiário
diferente do informado é diferente
beneficiário do do beneficiário contido
usuário no token de
autenticação
(authorization).
HTTP_UNAUTHORIZED (401) Cooperativa Parâmetro: Erro ocasionado quando
diferente da Cooperativa a cooperativa informada
cooperativa do é diferente da
usuário cooperativa contida no
token de autenticação
(authorization).
HTTP_BAD_REQUEST (400) O dia de pesquisa Parâmetro: Erro ocasionado quando
deve ter 10 dia a data de pesquisa está
caracteres e seguir inválida.
o padrão:
DD/MM/YYYY.
HTTP_BAD_REQUEST (400) BAD_REQUEST Parâmetro: Erro ocasionado quando
dia a data de pesquisa não
foi informada.
27/06/2022 Versão - 1.0 Página 103

HTTP_BAD_REQUEST (400) O campo código Parâmetro: Erro ocasionado quando

do beneficiário codigoBeneficiario o código do beneficiário
deve ter 5 (cinco) informado está inválido
caracteres ou não foi informado.
numéricos.
HTTP_BAD_REQUEST (400) Documento do Parâmetro: Erro ocasionado quando
beneficiário final cpfCnpjBeneficiarioFinal o cpf/cnpj do
inválido. beneficiário final
informado é inválido.
HTTP_TOO_MANY_REQUESTS Too many Não se aplica Erro ocasionado quando

(429) requests são enviadas muitas
espaço de tempo.
REQUEST – GET:

https://api-parceiro.sicredi.com.br/sb/cobranca/boleto/v1/boletos/liquidados/dia
cooperativa : 6789
posto: 03
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
27/06/2022 Versão - 1.0 Página 104

PARAMS:
codigoBeneficiario
dia
cpfCnpjBeneficiarioFinal
pagina
RESPONSE BODY:
{
"items": [
{
"cooperativa": "6789",
"codigoBeneficiario": "12345",
"cooperativaPostoBeneficiario": "678903",
"nossoNumero": "000000000",
"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
}
27/06/2022 Versão - 1.0 Página 105


▪ Headers:
▪ Params:
27/06/2022 Versão - 1.0 Página 106

27/06/2022 Versão - 1.0 Página 107

8. Geração Nosso Número

Se não for enviado o campo “nossoNumero” será retornado um “nossoNumero” gerado
automaticamente pelo webservice EComm-API. Caso seja enviado o campo “nossoNumero” na emissão
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
27/06/2022 Versão - 1.0 Página 108

ou seja, a nomenclatura correta é: 18200001-D
Fórmula para cálculo do dígito verificador pelo módulo 11:

a) Relacionar os códigos da cooperativa de crédito/agência do beneficiário (aaaa), posto do
beneficiário(pp), código do beneficiário
(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”:
27/06/2022 Versão - 1.0 Página 109

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
Caso o beneficiário opte por gerar a impressão do boleto, deverá providenciar a emissão do
mesmo de acordo com o layout especificado pelo Sicredi, conforme abaixo:
27/06/2022 Versão - 1.0 Página 110

10. Glossário
▪ Beneficiário: Empresa ou pessoa associada do Sicredi que contratou o produto Cobrança
com a sua cooperativa.
27/06/2022 Versão - 1.0 Página 111

▪ Código de Beneficiário / Código de convênio: Código gerado no momento da

contratação do 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:
1234 46 12346 NOME DA EMPRESA

Código de beneficiário
Posto
Cooperativa
▪ 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 BAIXADO_SOLICITACAO: Baixa solicitada pelo associado via comando de instrução ‘Baixa’.
Normalmente a baixa ocorre quando o associado recebeu o pagamento da dívida de alguma outra
forma e deseja que o boleto não esteja mais apto para pagamento.
o PROTESTADO: Boleto foi protestado em cartório, por solicitação do associado via comando de
instrução ‘Solicitação de Protesto’ ou por protesto automático.
o VENCIDO: Boleto está vencido e não foi pago ainda.
o EM_CARTORIO: Associado solicitou o protesto
o AGUARDANDO_ENTRADA_CARTORIO ...
o AGUARDANDO_SUSTACAO_CARTORIO ...
o REJEITADO ...
o NEGATIVADO...
o AGUARDANDO_NEGATIVACAO ...
o AGUARDANDO_RETIRADA_NEGATIVACAO ...
27/06/2022 Versão - 1.0 Página 112

11. Fluxos
11.1. Diagrama de Sequência de chamadas realizadas para o serviço
11.2.
27/06/2022 Versão - 1.0 Página 113

Manual Da API Da Cobrança 1.2

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual Da API Da Cobrança 1.2

Enviado por

Direitos autorais:

Formatos disponíveis

Manual API da

Classificação da informação: Uso Interno

27/06/2022 – Versão 1.0

27/06/2022 Versão - 1.0 Página 2

Classificação da informação: Uso Interno

Execução (via ferramenta Postman) .............................................................................................................. 63

27/06/2022 Versão - 1.0 Página 3

Classificação da informação: Uso Interno

Novas funcionalidades serão adicionadas e comunicadas ainda em 2022.

▪ Ter contratado o produto Cobrança através da sua cooperativa;

27/06/2022 Versão - 1.0 Página 4

Classificação da informação: Uso Interno

▪ Ter optado pela modalidade API (Cobrança Online);

▪ Autenticação: Operação responsável pela autenticação do código de acesso e criação do

o Boleto tradicional: Operação responsável pelo cadastro do pagador, do boleto, do

o Boleto Híbrido: Operação responsável pelo cadastro do pagador, e de todos os

▪ Comando de Instrução – Pedido de Baixa: Operação responsável por solicitar o pedido de

▪ Comando de Instrução – Alteração de Vencimento: Operação responsável por solicitar a

▪ Comando de Instrução – Alteração de Desconto: Operação responsável por solicitar a

▪ Comando de Instrução – Alteração de Data de Desconto: Operação responsável por

27/06/2022 Versão - 1.0 Página 5

Classificação da informação: Uso Interno

▪ Comando de Instrução – Alteração de Juros: Operação responsável por solicitar a alteração

▪ Comando de Instrução – Alteração de Seu Número: Operação responsável por solicitar a

Acessar o Portal do Desenvolvedor:

1.Criando a APP no portal 2. Selecionando as APIs na lista

27/06/2022 Versão - 1.0 Página 6

Classificação da informação: Uso Interno

b. Geração do Access Token de Homologação (Sandbox): após criar a APP de Homologação,

3. Visualizando o access token

Acessar o Portal do Desenvolvedor

Acessar o Internet Banking

b. Geração do Access Token de Produção: Repita os mesmos passos já realizados para a

4. Visualizando as APPs no menu

27/06/2022 Versão - 1.0 Página 7

Classificação da informação: Uso Interno

É importante lembrar que em todas as operações será necessário informar no cabeçalho

c. Geração do Código de Acesso (password): a empresa ou pessoa associada deve acessar o

5. Geração de Código de Acesso (password)

Se você ou a sua empresa associada não possui a modalidade habilitada e

27/06/2022 Versão - 1.0 Página 8

Classificação da informação: Uso Interno

Em todas as operações será necessário informar no cabeçalho da requisição no campo x-api-key

1 x-api-key String HeaderParam 36 UUID Access token Obrigatório

2 context String HeaderParam 8 COBRANCA Contexto, Obrigatório

27/06/2022 Versão - 1.0 Página 9

Classificação da informação: Uso Interno

3 Content- HeaderParam application/x- Indica o tipo Obrigatório

4 grant_typ String Body Até 13 password ou Tipo de Obrigatório

5 username String Body 9 Sem Código do Obrigatório

6 password String Body 64 Sem Código de Obrigatório

7 refresh_t String Body 753 Sem Refresh token Obrigatório

8 scope String Body 8 cobranca Escopo de Obrigatório

27/06/2022 Versão - 1.0 Página 10

Classificação da informação: Uso Interno

Erros ocasionados por

27/06/2022 Versão - 1.0 Página 11

Classificação da informação: Uso Interno

Erro ocasionado quando o

URL Sandbox (ambiente para homologação):

27/06/2022 Versão - 1.0 Página 12

Classificação da informação: Uso Interno

Execução (via ferramenta Postman)