# Integração Banco Sicoob - Via API
# Emissão Sicoob - Via API
Analista Responsável: Gustavo Henrique Braga Fernandes
Esse documento visa descrever os processos básicos para a integração com a API do Banco Sicoob. Inicialmente será implementada a emissão de boleto
# Primeiros Passos - Liberação - criação aplicativo
|
| **Projeto/Sistema:**
Emissão Sicoob - Via API
| **Versão do *Template:***
1.1 |
| **Processo:**
Primeiros Passos - Liberação - criação aplicativo e sandbox | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
02/01/2025
|
##### **1. Introdução**
**Este processo visa exemplificar o cadastro para libeação e criação do aplicativo, para emissão de boletos no banco Sicoob - via API.**
#### **Processos Relacionados**
- - - - - -
[Sandbox (homologação)](https://docs.softensistemas.com.br/books/siem-boleto/page/sandbox-homologacao "Sandbox (homologação)")
[Endpoints Produção (Exemplos JSON)](https://docs.softensistemas.com.br/books/siem-boleto/page/endpoints-producao-exemplos-json "Endpoints Produção (Exemplos JSON)")
#### **Especificação Funcional**
- - - - - -
#### **PROC001 CADASTRO NO PORTAL:**
Antes de tudo, será necessário possuir uma conta no ["Portal Developers - Sicoob".](https://developers.sicoob.com.br/portal/ ""Portal Developers - Sicoob".")
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1735830311176.png)
Será necessário preencher todos os dados para cadastro, inclusive o **CPF** do representante da empresa.
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1735830394293.png)
##### ***Gerar Aplicativo (Ambiente produção):***
Após realizar o acesso, cadastrando-se no portal, será necessário criar um novo aplicativo junto ao cliente.
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1735914442564.png)
**1.** Será necessário ser um cooperado e utilizar o AppSicoob para conseguir.
**(Fazer o procedimento junto com um cliente que já é cliente do banco Sicoob)**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1735914763921.png)
**2.** Seguir o passo a passo conforme documentação:
[Passo a passo criação aplicativo](https://developers.sicoob.com.br/portal/documentacao?slugItem=apis-do-sicoob&slugSubItem=aplicativos-de-producao "Passo a passo criação aplicativo")
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736168872954.png)
##### **Autenticação**
O fluxo de autenticação *Client Credentials* pode ser acessado pela URL abaixo:
**Geração do token:**
[https://auth.sicoob.com.br/auth/realms/cooperado/protocol/openid-connect/token](https://auth.sicoob.com.br/auth/realms/cooperado/protocol/openid-connect/token)
Você poderá visualizar o passo a passo de geração de token via Postman no vídeo disponibilizado no link a seguir.
**[Vídeo exemplo aqui.](https://developers.sicoob.com.br/portal/documentacao?slugItem=seguranca&slugSubItem=autenticacao "Vídeo exemplo aqui.")**
O fluxo de autenticação utilizado pelas APIs do Sicoob requer a utilização de **certificado digital** emitido por uma entidade certificadora **ICP Brasil** e deve ser emitido para o **CNPJ do cooperado**, quando PJ (Pessoa Jurídica) e para CPF do cooperado quando PF (Pessoa Física).
©SOFTEN SISTEMAS 2024
# Sandbox (homologação)
|
| **Projeto/Sistema:**
Emissão Sicoob - Via API
| **Versão do *Template:***
1.1 |
| **Processo:**
Sandbox (homologação) | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
08/01/2025
|
##### **1. Introdução**
**Este processo visa exemplificar a utilização do ambiente sandbox para registro de boletos no banco Sicoob - via API.**
#### **Processos Relacionados**
- - - - - -
[Primeiros Passos - Liberação - criação aplicativo](https://docs.softensistemas.com.br/books/siem-boleto/page/primeiros-passos-liberacao-criacao-aplicativo "Primeiros Passos - Liberação - criação aplicativo")
[Endpoints Produção (Exemplos JSON)](https://docs.softensistemas.com.br/books/siem-boleto/page/endpoints-producao-exemplos-json "Endpoints Produção (Exemplos JSON)")
#### **Especificação Funcional**
- - - - - -
#### **PROC002 SANDBOX (HOMOLOGAÇÃO):**
O ambiente de Sandbox foi criado especificamente para desenvolvedores que desejam testar as APIs do Sicoob.
##### **1) Acesse suas credenciais de teste:**
Antes de começar a utilizar o ambiente de sandbox, é necessário obter suas credenciais de teste. Estas:
#### Client ID
```
9b5e603e428cc477a2841e2683c92d21
```
#### Access token (Bearer)
```
1301865f-c6bc-38f3-9f49-666dbcfc59c3
```
**OBS: Vale ressaltar que estas credenciais não são válidas para produção!**
##### **2) Autenticação:**
É necessário fornecer no Header *Authorization* das requisições o Access token fornecido
##### **Endereços de Sandbox (Endpoints):**
**API Cobrança Bancária:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria/v3](https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria/v3)
**API Cobrança Bancária Pagamentos:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria-pagamentos/v3](https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria-pagamentos/v3)
**API Conta Corrente:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/conta-corrente/v4](https://sandbox.sicoob.com.br/sicoob/sandbox/conta-corrente/v4)
**API Convênios Pagamentos:** [https://sandbox.sicoob.com.br/sicoob/sandbox/convenios-pagamentos/v2](https://sandbox.sicoob.com.br/sicoob/sandbox/convenios-pagamentos/v2)
**API Investimentos - RDC:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/investimentos/v2](https://sandbox.sicoob.com.br/sicoob/sandbox/investimentos/v2)
**API Open Finance - Iniciação de Pagamento:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/payments/v2/itp](https://sandbox.sicoob.com.br/sicoob/sandbox/payments/v2/itp)
**API Pix Pagamentos:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/pix-pagamentos/v2](https://sandbox.sicoob.com.br/sicoob/sandbox/pix-pagamentos/v2)
**API Pix Recebimentos:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/pix/api/v2](https://sandbox.sicoob.com.br/sicoob/sandbox/pix/api/v2)
**API Poupança:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/poupanca/v3](https://sandbox.sicoob.com.br/sicoob/sandbox/poupanca/v3)
**API SPB Transferências:**
[https://sandbox.sicoob.com.br/sicoob/sandbox/spb/v2](https://sandbox.sicoob.com.br/sicoob/sandbox/spb/v2)
#### **Exemplos de requisição**
**Consultar Cobrança Imediata PIX**
```c
curl --location --request GET 'https://sandbox.sicoob.com.br/sicoob/sandbox/pix/api/v2/cob/:TXID' \
--header 'Authorization: Bearer {{Access Token}}' \
--header 'client_id: {{client_id}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
**Obs: O TXID é um path param que deve ser preenchido com o identificador único do QR Code. Ele deve conter de 27 a 36 caracteres.**
**Consultar Boleto**
```c
curl --location -g --request GET 'https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria/v3/boletos?numeroContrato={{numContrato}}&modalidade=1&nossoNumero=integer' \
--header 'Authorization: Bearer {{Access Token}}' \
--header 'client_id: {{client_id}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
```
**Obs: Os Headers seguirão um padrão para todas as APIs.**
©SOFTEN SISTEMAS 2024
# Endpoints Produção (Exemplos JSON)
|
| **Projeto/Sistema:**
Emissão Sicoob - Via API
| **Versão do *Template:***
1.1 |
| **Processo:**
Endpoints Produção (Exemplos JSON) | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
08/01/2025
|
##### **1. Introdução**
**Este processo visa exemplificar a utilização de endpoints, envio e retornos para registro de boletos no banco Sicoob - via API.**
#### **Processos Relacionados**
- - - - - -
[Primeiros Passos - Liberação - criação aplicativo](https://docs.softensistemas.com.br/books/siem-boleto/page/primeiros-passos-liberacao-criacao-aplicativo "Primeiros Passos - Liberação - criação aplicativo")
[Sandbox (homologação)](https://docs.softensistemas.com.br/books/siem-boleto/page/sandbox-homologacao "Sandbox (homologação)")
#### **Especificação Funcional**
- - - - - -
##### **AVISO IMPORTANTE**
**Desativação da API Cobrança Bancária V2**
Informamos que a API Cobrança Bancária **V2** será descontinuada em **30 de abril de 2025.** Essa medida está sendo tomada em função do lançamento da **API Cobrança Bancária V3**, que já está disponível e oferece melhorias significativas.
Orientamos que os cooperados que ainda utilizam a versão 2 realizem a migração para a versão 3 para garantir a continuidade dos serviços e o acesso às novas funcionalidades. Abaixo está o cronograma da desativação:
- **03/01/2025 Desativação da criação de credenciais para novas integrações:**Para incentivar a adoção da nova versão, não será mais possível criar credenciais para a API Cobrança Bancária V2. A criação de credenciais estará disponível apenas para a V3.
- **30/04/2025 Interrupção do funcionamento da API Cobrança Bancária V2:**A partir dessa data, a V2 da API será desativada. Todos os integradores e empresas parceiras que ainda utilizam a versão V2 devem migrar para a V3 antes desta data para evitar impactos nos serviços.
#### **PROC003 API DE COBRANÇA BANCÁRIA V3:**
Esta API disponibiliza serviços para recebimento de valores referentes às vendas de produtos e serviços da sua empresa, por meio de boletos de cobrança, pagos em toda a rede bancária.
**Funcionalidades**
- Gerenciamento de Boletos
- Alteração de informações de pagadores de boletos
- Negativação de pagadores
- Protesto de boletos
- Movimentação
**Especificações de uso da API**
[https://developers.sicoob.com.br/portal/documentacao?slugItem=apis&slugSubItem=cobranca-bancaria-v3](https://developers.sicoob.com.br/portal/documentacao?slugItem=apis&slugSubItem=cobranca-bancaria-v3)
#### ***Questões Técnicas:***
### **1. Cobrança Bancária Pagamentos**
**BASE URL: [https://api.sicoob.com.br/pagamentos/v3](https://api.sicoob.com.br/pagamentos/v3)**
(Esta API disponibiliza funcionalidades para realização de pagamentos de boletos de Cobrança Bancária.)
#### **1.1 Pagamento** (Pagamento de Boletos de Cobrança)
#####
**1.1.1 Serviço para consultar boleto:**
| Método HTTP
| URL
|
| GET
| /boletos/{codigoBarras}
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736348677063.png)
**Resposta esperada:**
**Exemplo retorno:**
```json
{
"resultado": {
"numeroInstituicaoEmissora": 756,
"nomeInstituicaoEmissora": "Banco Cooperativo do Brasil",
"tipoPessoaBeneficiario": "F",
"numeroCpfCnpjBeneficiario": "12345678900",
"nomeRazaoSocialBeneficiario": "José da Silva",
"nomeFantasiaBeneficiario": "Estilo Tech",
"tipoPessoaBeneficiarioFinal": "2",
"numeroCpfCnpjBeneficiarioFinal": "12345678900",
"nomeRazaoSocialBeneficiarioFinal": "João das Flores",
"nomeFantasiaBeneficiarioFinal": "Quitanda do João",
"tipoPessoaPagador": "F",
"numeroCpfCnpjPagador": "12345678900",
"nomeRazaoSocialPagador": "Maria José",
"nomeFantasiaPagador": "Rosa Maria da Silva",
"codigoBarras": "string",
"numeroLinhaDigitavel": "string",
"dataVencimentoBoleto": "2021-04-20",
"dataLimitePagamentoBoleto": "2021-04-25",
"valorBoleto": 152.3,
"valorAbatimentoDesconto": 0,
"valorMultaMora": 0,
"valorPagamento": 152.3,
"dataPagamento": "2021-04-24",
"permiteAlterarValor": true,
"consultaEmContingencia": false,
"codigoEspecieDocumento": 25,
"codigoSituacaoBoletoPagamento": "12",
"nossoNumero": "123789",
"numeroDocumento": "123456",
"identificadorConsulta": "hash",
"descricaoInstrucaoDesconto1": "Conceder desconto de 10% até 05/04/2021",
"descricaoInstrucaoDesconto2": "Conceder desconto de 5% até 10/04/2021",
"descricaoInstrucaoDesconto3": "Conceder desconto de 2% até 05/04/2021",
"descricaoInstrucaoValorMinMax": "O Valor Mínimo é R$ 0,01. O Valor Máximo é R$ 99.999.999,99",
"bloquearPagamento": true,
"mensagemBloqueioPagamento": "Pagamento bloqueado"
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
##### **1.1.2 Serviço para efetuar o pagamento ou agendamento de boleto.**
| Método HTTP
| URL
|
| POST
| /boletos/pagamentos/{codigoBarras}
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736349536996.png)
Exemplo valor | Modelo: **(boletoPagamento)**
```json
{
"identificadorConsulta": "hash",
"valorBoleto": 152.3,
"valorDescontoAbatimento": 0,
"valorMultaMora": 0,
"descricaoObservacao": "Boleto da Escola",
"aceitaValorDivergente": true,
"numeroCpfCnpjPortador": "12345678900",
"nomePortador": "Rosa Maria da Silva",
"amount": 152.3,
"date": "2021-04-24",
"debtorAccount": {
"issuer": 1234,
"number": 1234569,
"accountType": 0,
"personType": 0
}
}
```
**Resposta esperada:**
**Exemplo retorno:**
```json
{
"resultado": {
"numeroAgencia": "0001-9",
"nomeAgencia": "Agência Sede",
"numeroConta": 1234569,
"nomeProprietarioContaCorrente": "José da Silva",
"numeroLinhaDigitavel": "string",
"numeroInstituicaoEmissora": 756,
"nomeInstituicaoEmissora": "Banco Cooperativo do Brasil",
"numeroCpfCnpjBeneficiario": "12345678900",
"nomeRazaoSocialBeneficiario": "José da Silva",
"nomeFantasiaBeneficiario": "Estilo Tech",
"numeroCpfCnpjBeneficiarioFinal": "12345678900",
"nomeRazaoSocialBeneficiarioFinal": "João das Flores",
"nomeFantasiaBeneficiarioFinal": "Quinatda dojão",
"numeroCpfCnpjPagador": "12345678900",
"nomeRazaoSocialPagador": "Maria José",
"nomeFantasiaPagador": "Rosa Maria da Silva",
"dataVencimento": "2018-09-20",
"valorBoleto": 100.36,
"valorAbatimentoDesconto": 0,
"valorMultaMora": 60.36,
"valorPagamento": 255.63,
"dataPagamento": "2019-10-20",
"situacaoPagamento": "Efetivado",
"descricaoDetalheSituacao": "Saldo no momento da rejeição em 10/03/2021 às 22:01:10: R$ 343,05.",
"dataHoraCadastro": "2019-10-20T12:30:22.000Z",
"aceitaValorDivergente": true,
"nossoNumero": "756",
"numeroDocumento": "123456",
"descricaoObservacao": "Boleto da Escola",
"descricaoOuvidoria": "OUVIDORIA AGIBANK: 08007250996",
"descricaoTituloComprovante": "PAGAMENTO DE BOLETO",
"idPagamento": 1983450,
"numeroAutenticacaoPagamento": "89C3E9FD-1A37-40BE-A85B-69AF118D336A"
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
##### **1.1.3 Serviço para consultar um comprovante de um pagamento efetuado.**
| Método HTTP
| URL
|
| GET
| /boletos/pagamentos/{idPagamento}/comprovantes
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736360421037.png)
**Resposta esperada:**
**Exemplo retorno:**
```json
{
"resultado": {
"numeroAgencia": "0001-9",
"nomeAgencia": "Agência Sede",
"numeroConta": 1234569,
"nomeProprietarioContaCorrente": "José da Silva",
"numeroLinhaDigitavel": "string",
"numeroInstituicaoEmissora": 756,
"nomeInstituicaoEmissora": "Banco Cooperativo do Brasil",
"numeroCpfCnpjBeneficiario": "12345678900",
"nomeRazaoSocialBeneficiario": "José da Silva",
"nomeFantasiaBeneficiario": "Estilo Tech",
"numeroCpfCnpjBeneficiarioFinal": "12345678900",
"nomeRazaoSocialBeneficiarioFinal": "João das Flores",
"nomeFantasiaBeneficiarioFinal": "Quinatda dojão",
"numeroCpfCnpjPagador": "12345678900",
"nomeRazaoSocialPagador": "Maria José",
"nomeFantasiaPagador": "Rosa Maria da Silva",
"dataVencimento": "2018-09-20",
"valorBoleto": 100.36,
"valorAbatimentoDesconto": 0,
"valorMultaMora": 60.36,
"valorPagamento": 255.63,
"dataPagamento": "2019-10-20",
"situacaoPagamento": "Efetivado",
"descricaoDetalheSituacao": "Saldo no momento da rejeição em 10/03/2021 às 22:01:10: R$ 343,05.",
"dataHoraCadastro": "2019-10-20T12:30:22.000Z",
"aceitaValorDivergente": true,
"nossoNumero": "756",
"numeroDocumento": "123456",
"descricaoObservacao": "Boleto da Escola",
"descricaoOuvidoria": "OUVIDORIA AGIBANK: 08007250996",
"descricaoTituloComprovante": "PAGAMENTO DE BOLETO",
"idPagamento": 1983450,
"numeroAutenticacaoPagamento": "89C3E9FD-1A37-40BE-A85B-69AF118D336A"
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
##### **1.1.4 Serviço para cancelar um agendamento de pagamento.**
| Método HTTP
| URL
|
| DELETE
| /boletos/pagamentos/agendamentos/{idPagamento}
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736361112205.png)
Exemplo valor | Modelo: **(cancelamento)**
```json
{
"numeroConta": 1234569
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
##### **1.1.5 Serviço para consultar um comprovante de um pagamento efetuado atarvés do idempotency**
| Método HTTP
| URL
|
| GET
| /boletos/pagamentos/{idempotency}/idempotency/comprovantes
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-01/image-1736361549118.png)
**Resposta esperada:**
**Exemplo retorno:**
```json
{
"resultado": {
"numeroAgencia": "0001-9",
"nomeAgencia": "Agência Sede",
"numeroConta": 1234569,
"nomeProprietarioContaCorrente": "José da Silva",
"numeroLinhaDigitavel": "string",
"numeroInstituicaoEmissora": 756,
"nomeInstituicaoEmissora": "Banco Cooperativo do Brasil",
"numeroCpfCnpjBeneficiario": "12345678900",
"nomeRazaoSocialBeneficiario": "José da Silva",
"nomeFantasiaBeneficiario": "Estilo Tech",
"numeroCpfCnpjBeneficiarioFinal": "12345678900",
"nomeRazaoSocialBeneficiarioFinal": "João das Flores",
"nomeFantasiaBeneficiarioFinal": "Quinatda dojão",
"numeroCpfCnpjPagador": "12345678900",
"nomeRazaoSocialPagador": "Maria José",
"nomeFantasiaPagador": "Rosa Maria da Silva",
"dataVencimento": "2018-09-20",
"valorBoleto": 100.36,
"valorAbatimentoDesconto": 0,
"valorMultaMora": 60.36,
"valorPagamento": 255.63,
"dataPagamento": "2019-10-20",
"situacaoPagamento": "Efetivado",
"descricaoDetalheSituacao": "Saldo no momento da rejeição em 10/03/2021 às 22:01:10: R$ 343,05.",
"dataHoraCadastro": "2019-10-20T12:30:22.000Z",
"aceitaValorDivergente": true,
"nossoNumero": "756",
"numeroDocumento": "123456",
"descricaoObservacao": "Boleto da Escola",
"descricaoOuvidoria": "OUVIDORIA AGIBANK: 08007250996",
"descricaoTituloComprovante": "PAGAMENTO DE BOLETO",
"idPagamento": 1983450,
"numeroAutenticacaoPagamento": "89C3E9FD-1A37-40BE-A85B-69AF118D336A"
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#### **1.2 Movimentações DDA** (Movimentações feitas no sistema DDA)
##### **1.2.1 Serviço para consultar boletos DDA de uma conta corrente:**
| Método HTTP
| URL
|
| GET
| /boletos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738606299973.png)
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738606335917.png)
**Resposta esperada:**
**Exemplo retorno:**
```json
[
{
"descricaoTipoPagador": "string",
"tipoPessoaBeneficiario": "string",
"numeroCpfCnpjBeneficiario": "string",
"nomeRazaoSocialBeneficiario": "string",
"tipoPessoaPagador": "string",
"numeroCpfCnpjPagador": "string",
"nomeRazaoSocialPagador": "string",
"nomeFantasiaPagador": "string",
"descricaoLogradouroPagador": "string",
"descricaoCidadePagador": "string",
"siglaUfPagador": "string",
"numeroCepPagador": "string",
"tipoPessoaAvalista": "string",
"numeroCpfCnpjAvalista": "string",
"nomeAvalista": "string",
"valorBoleto": 0,
"dataVencimentoBoleto": "2025-02-03",
"codigoTipoSituacaoBoleto": 0,
"descricaoSituacaoBoleto": "string",
"numeroIdentificadorBoletoCip": 0,
"numeroCodigoBarras": "string",
"numeroCpfCnpjPagadorEletronico": "string",
"aceite": true,
"numeroNossoNumero": "string",
"numeroDocumento": "string",
"dataPagamento": "2025-02-03",
"valorPagamento": 0,
"codigoEspecieDocumento": 0,
"dataEmissao": "2025-02-03",
"dataLimitePagamento": "string",
"codigoTipoJuros": 0,
"dataJuros": "2025-02-03",
"valorPercentualJuros": 0,
"codigoTipoMulta": 0,
"dataMulta": "2025-02-03",
"valorPercentualMulta": 0,
"valorAbatimento": 0,
"codigoTipoDesconto1": "string",
"dataDesconto1": "2025-02-03",
"valorPercentualDesconto1": 0,
"codigoTipoDesconto2": "string",
"dataDesconto2": "string",
"valorPercentualDesconto2": 0,
"codigoTipoDesconto3": "string",
"dataDesconto3": "string",
"valorPercentualDesconto3": 0,
"numeroDiasProtesto": 0,
"quantidadePagamentoParcial": 0,
"codigoAutorizacaoValorDivergente": 0,
"codigoIndicadorValorMaximo": "string",
"valorPercentualMaximo": 0,
"codigoIndicadorValorMinimo": "string",
"valorPercentualMinimo": 0
}
]
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| Requisição processada com sucesso e não há conteúdo a ser retornado.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
### **2. Cobrança Bancária v3**
**BASE URL: [https://api.sicoob.com.br/cobranca-bancaria/v3](https://api.sicoob.com.br/cobranca-bancaria/v3)**
(A Cobrança Bancária Sicoob é um conjunto de serviços oferecidos a seus associados para recebimento de valores referentes às vendas de produtos e serviços da sua empresa, por meio de boletos de cobrança, pagos em toda a rede bancária. Esta API disponibiliza funcionalidades que auxiliam na gestão da carteira registrada, tornando viável todo o processo de acompanhamento, desde a inclusão de novos boletos, alteração de informações relevantes, protesto/negativação de títulos vencidos e não pagos, até a liquidação ou baixa do título.)
#### **2.1 Boleto** (Inclusão e Manutenção de Boleto Bancário)
##### **2.1.1 Serviço para a inclusão de boletos.**
**É possível a inclusão de 1 boleto por requisição:**
| Método HTTP
| URL
|
| POST
| /boletos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738671544662.png)
Exemplo valor | Modelo: **(boleto)**
```json
{
"numeroCliente": 25546454,
"codigoModalidade": 1,
"numeroContaCorrente": 0,
"codigoEspecieDocumento": "DM",
"dataEmissao": "2018-09-20",
"nossoNumero": 2588658,
"seuNumero": "1235512",
"identificacaoBoletoEmpresa": "4562",
"identificacaoEmissaoBoleto": 1,
"identificacaoDistribuicaoBoleto": 1,
"valor": 156.23,
"dataVencimento": "2018-09-20",
"dataLimitePagamento": "2018-09-20",
"valorAbatimento": 1,
"tipoDesconto": 1,
"dataPrimeiroDesconto": "2018-09-20",
"valorPrimeiroDesconto": 1,
"dataSegundoDesconto": "2018-09-20",
"valorSegundoDesconto": 0,
"dataTerceiroDesconto": "2018-09-20",
"valorTerceiroDesconto": 0,
"tipoMulta": 1,
"dataMulta": "2018-09-20",
"valorMulta": 5,
"tipoJurosMora": 1,
"dataJurosMora": "2018-09-20",
"valorJurosMora": 4,
"numeroParcela": 1,
"aceite": true,
"codigoNegativacao": 2,
"numeroDiasNegativacao": 60,
"codigoProtesto": 1,
"numeroDiasProtesto": 30,
"pagador": {
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos",
"endereco": "Rua 87 Quadra 1 Lote 1 casa 1",
"bairro": "Santa Rosa",
"cidade": "Luziânia",
"cep": "72320000",
"uf": "DF",
"email": "pagador@dominio.com.br"
},
"beneficiarioFinal": {
"numeroCpfCnpj": "98784978699",
"nome": "Lucas de Lima"
},
"mensagensInstrucao": [
"Descrição da Instrução 1",
"Descrição da Instrução 2",
"Descrição da Instrução 3",
"Descrição da Instrução 4",
"Descrição da Instrução 5"
],
"gerarPdf": false,
"rateioCreditos": [
{
"numeroBanco": 756,
"numeroAgencia": 4027,
"numeroContaCorrente": 0,
"contaPrincipal": true,
"codigoTipoValorRateio": 1,
"valorRateio": 100,
"codigoTipoCalculoRateio": 1,
"numeroCpfCnpjTitular": "98765432185",
"nomeTitular": "Marcelo dos Santos",
"codigoFinalidadeTed": 10,
"codigoTipoContaDestinoTed": "CC",
"quantidadeDiasFloat": 1,
"dataFloatCredito": "2020-12-30"
}
],
"codigoCadastrarPIX": 1,
"numeroContratoCobranca": 1
}
```
**Resposta esperada:**
| Code
| Description
|
| 200
| Solicitação recebida com sucesso
|
**Exemplo retorno:**
```json
{
"resultado": {
"numeroCliente": 25546454,
"codigoModalidade": 1,
"numeroContaCorrente": 0,
"codigoEspecieDocumento": "DM",
"dataEmissao": "2018-09-20",
"nossoNumero": 0,
"seuNumero": "1235512",
"identificacaoBoletoEmpresa": "4562",
"codigoBarras": "",
"linhaDigitavel": "",
"identificacaoEmissaoBoleto": 1,
"identificacaoDistribuicaoBoleto": 1,
"valor": 156.23,
"dataVencimento": "2018-09-20",
"dataLimitePagamento": "2018-09-20",
"valorAbatimento": 1,
"tipoDesconto": 1,
"dataPrimeiroDesconto": "2018-09-20",
"valorPrimeiroDesconto": 1,
"dataSegundoDesconto": "2018-09-20",
"valorSegundoDesconto": 0,
"dataTerceiroDesconto": "2018-09-20",
"valorTerceiroDesconto": 0,
"tipoMulta": 1,
"dataMulta": "2018-09-20",
"valorMulta": 5,
"tipoJurosMora": 1,
"dataJurosMora": "2018-09-20",
"valorJurosMora": 4,
"numeroParcela": 1,
"aceite": true,
"codigoNegativacao": 2,
"numeroDiasNegativacao": 60,
"codigoProtesto": 1,
"numeroDiasProtesto": 30,
"quantidadeDiasFloat": 2,
"pagador": {
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos",
"endereco": "Rua 87 Quadra 1 Lote 1 casa 1",
"bairro": "Santa Rosa",
"cidade": "Luziânia",
"cep": "72320000",
"uf": "DF",
"email": "pagador@dominio.com.br"
},
"beneficiarioFinal": {
"numeroCpfCnpj": "98784978699",
"nome": "Lucas de Lima"
},
"mensagensInstrucao": [
"Descrição da Instrução 1",
"Descrição da Instrução 2",
"Descrição da Instrução 3",
"Descrição da Instrução 4",
"Descrição da Instrução 5"
],
"rateioCreditos": [
{
"numeroBanco": 756,
"numeroAgencia": 4027,
"numeroContaCorrente": 0,
"contaPrincipal": true,
"codigoTipoValorRateio": 1,
"valorRateio": 100,
"codigoTipoCalculoRateio": 1,
"numeroCpfCnpjTitular": "98765432185",
"nomeTitular": "Marcelo dos Santos",
"codigoFinalidadeTed": 10,
"codigoTipoContaDestinoTed": "CC",
"quantidadeDiasFloat": 1,
"dataFloatCredito": "2020-12-30"
}
],
"pdfBoleto": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1hPYmplY3QvU3VidHlwZS9JbWFnZS9XaWR0aCA1Nzgv+PgolaVRleHQtNS41LjExCnN0YXJ0eHJlZgoyNzAxOQolJUVPRgo=",
"qrCode": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3",
"numeroContratoCobranca": 1,
"descricaoRejeicaoPix": "Modalidade não permitida para geração de QR Code."
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
##### **2.1.2 Serviço para consulta de um boleto bancário.**
**Utiliza as informações do beneficiário logado (número da cooperativa, número identificador do beneficiário e conta corrente), juntamente com a informação do identificador do boleto (nosso número), ou da linha digitável ou do código de barras:**
| Método HTTP
| URL
|
| GET
| /boletos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738673243385.png)
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738673273891.png)
**Resposta esperada:**
| Code
| Description
|
| 200
| Solicitação recebida com sucesso
|
**Exemplo retorno:**
```json
{
"resultado": {
"numeroCliente": 25546454,
"codigoModalidade": 1,
"numeroContaCorrente": 0,
"codigoEspecieDocumento": "DM",
"dataEmissao": "2018-09-20",
"nossoNumero": 0,
"seuNumero": "1235512",
"identificacaoBoletoEmpresa": "4562",
"codigoBarras": "",
"linhaDigitavel": "",
"identificacaoEmissaoBoleto": 1,
"identificacaoDistribuicaoBoleto": 1,
"valor": 156.23,
"dataVencimento": "2018-09-20",
"dataLimitePagamento": "2018-09-20",
"valorAbatimento": 1,
"tipoDesconto": 1,
"dataPrimeiroDesconto": "2018-09-20",
"valorPrimeiroDesconto": 1,
"dataSegundoDesconto": "2018-09-20",
"valorSegundoDesconto": 0,
"dataTerceiroDesconto": "2018-09-20",
"valorTerceiroDesconto": 0,
"tipoMulta": 1,
"dataMulta": "2018-09-20",
"valorMulta": 5,
"tipoJurosMora": 1,
"dataJurosMora": "2018-09-20",
"valorJurosMora": 4,
"numeroParcela": 1,
"aceite": true,
"codigoNegativacao": 2,
"numeroDiasNegativacao": 60,
"codigoProtesto": 1,
"numeroDiasProtesto": 30,
"quantidadeDiasFloat": 2,
"pagador": {
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos",
"endereco": "Rua 87 Quadra 1 Lote 1 casa 1",
"bairro": "Santa Rosa",
"cidade": "Luziânia",
"cep": "72320000",
"uf": "DF",
"email": "pagador@dominio.com.br"
},
"beneficiarioFinal": {
"numeroCpfCnpj": "98784978699",
"nome": "Lucas de Lima"
},
"mensagensInstrucao": [
"Descrição da Instrução 1",
"Descrição da Instrução 2",
"Descrição da Instrução 3",
"Descrição da Instrução 4",
"Descrição da Instrução 5"
],
"listaHistorico": [
{
"dataHistorico": "2019-05-31",
"tipoHistorico": "1",
"descricaoHistorico": "TARIFA - TAR. MANUTENÇÃO DE TÍTULO VENCIDO - R$ 0,75"
}
],
"situacaoBoleto": "Em Aberto",
"rateioCreditos": [
{
"numeroBanco": 756,
"numeroAgencia": 4027,
"numeroContaCorrente": 0,
"contaPrincipal": true,
"codigoTipoValorRateio": 1,
"valorRateio": 100,
"codigoTipoCalculoRateio": 1,
"numeroCpfCnpjTitular": "98765432185",
"nomeTitular": "Marcelo dos Santos",
"codigoFinalidadeTed": 10,
"codigoTipoContaDestinoTed": "CC",
"quantidadeDiasFloat": 1,
"dataFloatCredito": "2020-12-30"
}
],
"qrCode": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3",
"numeroContratoCobranca": 1
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| A requisição foi processada com êxito e não está retornando conteúdo.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.1.3 Serviço para listagem de boletos por Pagador:**
| Método HTTP
| URL
|
| GET
| /pagadores/{numeroCpfCnpj}/boletos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738673916116.png)
**Resposta esperada:**
| Code
| Description
|
| 200
| Solicitação recebida com sucesso
|
**Exemplo retorno:**
```json
{
"resultado": [
{
"numeroCliente": 25546454,
"codigoModalidade": 1,
"numeroContaCorrente": 0,
"codigoEspecieDocumento": "DM",
"dataEmissao": "2018-09-20",
"nossoNumero": 0,
"seuNumero": "1235512",
"identificacaoBoletoEmpresa": "4562",
"codigoBarras": "",
"linhaDigitavel": "",
"valor": 156.23,
"dataVencimento": "2018-09-20",
"valorAbatimento": 1,
"tipoDesconto": 0,
"dataPrimeiroDesconto": "2018-09-20",
"valorPrimeiroDesconto": 1,
"dataSegundoDesconto": "2018-09-20",
"valorSegundoDesconto": 0,
"dataTerceiroDesconto": "2018-09-20",
"valorTerceiroDesconto": 0,
"tipoMulta": 1,
"dataMulta": "2018-09-20",
"valorMulta": 5,
"tipoJurosMora": 1,
"dataJurosMora": "2018-09-20",
"valorJurosMora": 4,
"numeroParcela": 1,
"aceite": true,
"codigoNegativacao": 2,
"codigoProtesto": 1,
"quantidadeDiasFloat": 2,
"pagador": {
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos"
},
"beneficiarioFinal": {
"nome": "Lucas de Lima"
},
"mensagensInstrucao": [
"Descrição da Instrução 1",
"Descrição da Instrução 2",
"Descrição da Instrução 3",
"Descrição da Instrução 4",
"Descrição da Instrução 5"
],
"situacaoBoleto": "Liquidado",
"qrCode": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3",
"numeroContratoCobranca": 1
}
]
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| A requisição foi processada com êxito e não está retornando conteúdo.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.1.4 Serviço para emissão da segunda via de boleto já registrado.**
**Utiliza as informações do beneficiário logado (número da cooperativa, número identificador do beneficiário e conta corrente), juntamente com a informação do identificador do boleto (nosso número), ou da linha digitável ou do código de barras. Quando informados código de barras ou linha digitável, a pesquisa é realiazada prioritariamente por estes parâmetros.**
| Método HTTP
| URL
|
| GET
| /boletos/segunda-via
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738675460368.png)
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738675491382.png)
**Resposta esperada:**
| Code
| Description
|
| 200
| Solicitação recebida com sucesso
|
**Exemplo retorno:**
```json
{
"resultado": {
"numeroCliente": 25546454,
"codigoModalidade": 1,
"codigoEspecieDocumento": "DM",
"dataEmissao": "2018-09-20",
"nossoNumero": 0,
"seuNumero": "1235512",
"codigoBarras": "",
"linhaDigitavel": "",
"valor": 156.23,
"dataVencimento": "2018-09-20",
"valorAbatimento": 1,
"numeroParcela": 1,
"aceite": true,
"tipoMulta": 1,
"valorMulta": 5.01,
"tipoJurosMora": 1,
"valorJurosMora": 4,
"pagador": {
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos",
"endereco": "Rua 87 Quadra 1 Lote 1 casa 1",
"bairro": "Santa Rosa",
"cidade": "Luziânia",
"cep": "72320000",
"uf": "DF",
"email": "pagador@dominio.com.br"
},
"beneficiarioFinal": {
"numeroCpfCnpj": "98784978699",
"nome": "Lucas de Lima"
},
"mensagensInstrucao": [
"Descrição da Instrução 1",
"Descrição da Instrução 2",
"Descrição da Instrução 3",
"Descrição da Instrução 4",
"Descrição da Instrução 5"
],
"pdfBoleto": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1hPYmplY3QvU3VidHlwZS9JbWFnZS9XaWR0aCA1Nzgv+PgolaVRleHQtNS41LjExCnN0YXJ0eHJlZgoyNzAxOQolJUVPRgo=",
"qrCode": "00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3",
"numeroContratoCobranca": 1
}
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| A requisição foi processada com êxito e não está retornando conteúdo.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.1.5 Serviço para consulta de dados de faixas de nosso número disponíveis.**
**Quando o campo validaDigitoVerificadorNossoNumero retornar o valor "0" a faixa "numeroInicial" e "numeroFinal" refere-se a numeração final (exemplo: 10 e 15 - utilização: 1-0 1-1 1-2 1-3 1-4 1-5).
Mas se o campo validaDigitoVerificadorNossoNumero retornar o valor "1" a faixa "numeroInicial" e "numeroFinal" deverá ser calculado o DV (exemplo: 10 e 15 - utilização: 10-4 11-8 12-0 13-1 14-7 15-9):**
| Método HTTP
| URL
|
| GET
| /boletos/faixas-nosso-numero
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738676815967.png)
**Resposta esperada:**
| Code
| Description
|
| 200
| Solicitação recebida com sucesso
|
**Exemplo retorno:**
```json
{
"resultado": [
{
"numeroCliente": 5224,
"nome": "JOSE PEREIRA",
"codigoModalidade": 1,
"numeroInicial": 1,
"numeroFinal": 10,
"quantidade": 10,
"numeroContratoCobranca": 1,
"validaDigitoVerificadorNossoNumero": true
}
]
}
```
**Respostas possíveis:**
| Code
| Description
|
| 204
| A requisição foi processada com êxito e não está retornando conteúdo.
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.1.6 Serviço para alteração de dados de boleto já registrado.**
**Deve ser feita a alteração de somente um objeto do boleto por requisição.**
**Objetos de alteração do boleto:**
- seuNumero
- desconto
- abatimento
- multa
- jurosMora
- rateioCredito
- pix
- prorrogacaoVencimento
- prorrogacaoLimitePagamento
| Método HTTP
| URL
|
| PATH
| /boletos/{nossoNumero}
|
**Parêmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738677898243.png)
Exemplo valor | Modelo: **(boleto)**
```json
{
"numeroCliente": 25546454,
"codigoModalidade": 1,
"numeroContratoCobranca": 1,
"especieDocumento": {
"codigoEspecieDocumento": "DM"
},
"seuNumero": {
"seuNumero": "209",
"identificacaoBoletoEmpresa": "209"
},
"desconto": {
"tipoDesconto": 1,
"dataPrimeiroDesconto": "2018-09-20",
"valorPrimeiroDesconto": 1,
"dataSegundoDesconto": "2018-09-20",
"valorSegundoDesconto": 0,
"dataTerceiroDesconto": "2018-09-20",
"valorTerceiroDesconto": 0
},
"abatimento": {
"valorAbatimento": 156.23
},
"multa": {
"tipoMulta": 1,
"dataMulta": "2018-09-20",
"valorMulta": 5
},
"jurosMora": {
"tipoJurosMora": 1,
"dataJurosMora": "2018-09-20",
"valorJurosMora": 4
},
"rateioCredito": {
"tipoOperacao": 2,
"rateioCreditos": [
{
"numeroBanco": 756,
"numeroAgencia": 4027,
"numeroContaCorrente": 0,
"contaPrincipal": true,
"codigoTipoValorRateio": 1,
"valorRateio": 100,
"codigoTipoCalculoRateio": 1,
"numeroCpfCnpjTitular": "98765432185",
"nomeTitular": "Marcelo dos Santos",
"codigoFinalidadeTed": 10,
"codigoTipoContaDestinoTed": "CC",
"quantidadeDiasFloat": 1,
"dataFloatCredito": "2020-12-30"
}
]
},
"pix": {
"utilizarPix": false
},
"prorrogacaoVencimento": {
"dataVencimento": "2018-09-20"
},
"prorrogacaoLimitePagamento": {
"dataLimitePagamento": "2018-09-20"
},
"valorNominal": {
"valor": 156.23
}
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Alteração realizada com sucesso
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.1.7 Serviço para comandar a baixa de boletos informados:**
| Método HTTP
| URL
|
| POST
| /boletos/{nossoNumero}/baixar
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738679626931.png)
Exemplo valor | Modelo: **(boleto)**
```json
{
"numeroCliente": 5224,
"codigoModalidade": 1
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Alteração realizada com sucesso
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
#### **2.2 Pagador** (Inclusão e Manutenção de Pagador)
##### **2.2.1 Serviço para alterar informações do cadastro do pagador.**
| Método HTTP
| URL
|
| PUT
| /pagadores
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738680432499.png)
Exemplo valor | Modelo: **(pagador)**
```json
{
"numeroCliente": 25546454,
"numeroCpfCnpj": "98765432185",
"nome": "Marcelo dos Santos",
"endereco": "Rua 87 Quadra 1 Lote 1 casa 1",
"bairro": "Santa Rosa",
"cidade": "Luziânia",
"cep": "72320000",
"uf": "DF",
"email": "pagador@dominio.com.br"
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Solicitação recebida com sucesso.
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
#### **2.3 Protesto** (Protesto de Boleto Bancário Vencido e Não Pago)
##### **2.3.1 Este serviço registra a indicação a protesto de boletos informados.**
**Os boletos vencidos e não pagos podem ser protestados e registrados em cartório.**
| Método HTTP
| URL
|
| POST
| /boletos/{nossoNumero}/protestos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738683544872.png)
Exemplo valor | Modelo: **(boletos)**
```json
{
"numeroCliente": 25546454,
"codigoModalidade": 1
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Solicitação recebida com sucesso.
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.3.2 Este serviço realiza a indicação de cancelamento de protesto de boletos informados.**
**Os boletos em atraso e não pagos podem ser indicados a protesto. Caso seja realizado no mesmo dia, pode-se cancelar o apontamento a protesto.**
| Método HTTP
| URL
|
| PATCH
| /boletos/{nossoNumero}/protestos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738683878168.png)
Exemplo valor | Modelo: **(boleto)**
```json
{
"numeroCliente": 25546454,
"codigoModalidade": 1
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Solicitação recebida com sucesso.
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#####
##### **2.3.3 Este serviço realiza o pedido de desistência do protesto de boletos informados.**
**O pedido de desistência não garante que o protesto será retirado. Deve-se aguardar o retorno do cartório. O pedido de desistência pode ser realizado a qualquer momento, desde que haja um apontamento prévio.**
| Método HTTP
| URL
|
| DELETE
| /boletos/{nossoNumero}/protestos
|
**Parâmetros:**
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1738684114243.png)
Exemplo valor | Modelo: **(boleto)**
```json
{
"numeroCliente": 25546454,
"codigoModalidade": 1
}
```
**Resposta esperada:**
| Code
| Description
|
| 204
| Solicitação recebida com sucesso.
|
**Respostas possíveis:**
| Code
| Description
|
| 400
| Possíveis erros de negócio.
|
| 406
| Possíveis erros de inconsistência nos dados passados.
|
| 500
| Erro interno.
|
**Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)**
```json
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
```
#### **Acesso para conferir o catalógo completo das API's:** [Catálogo de API's](https://developers.sicoob.com.br/portal/apis "Catálogo de API's")
©SOFTEN SISTEMAS 2024
# Emissão de Boletos - SIEM
Analistas Responsável: Gustavo Henrique Braga Fernandes
Este processo visa exemplificar as configurações necessárias e protótipos de tela para emissão de boletos via API, Banco Sicoob no SoftenSIEM
# PROC001 Configurações
|
| **Projeto/Sistema:**
Emissão de Boletos - SIEM
| **Versão do *Template:***
1.1 |
| **Processo:**
PROC001 Configurações | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
10/02/2025
|
##### **1. Introdução**
**Este processo visa exemplificar as configurações 2 necessárias para utilização do banco Sicoob via API.**
#### **Processos Relacionados**
- - - - - -
[PROC002 Preenchimento da Carteira](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/proc002-preenchimento-da-carteira "PROC002 Preenchimento da Carteira")
#### **Especificação Funcional**
- - - - - -
#### **PROC001 Configurações:**
##### ***Protótipo de Tela:***
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739274724131.png)
*Imagem 1 - Tela Configurações 2*
##### ***Regras de Negócio:***
***1. FINANCEIRO: AMBIENTE DE ENVIO BANCO SICOOB (0=HOMOLOGACAO(PADRAO)/1=PRODUCAO):***
Identifica se o valor será enviado para ambiente de testes nos **ENDEREÇOS DE** **SANDBOX** ou diretamente para ambiente de **PRODUÇÃO,** a diferença será nos endereços que ele vai acessar em cada ambiente.
| Método HTTP
| URL
|
| GET
| /boletos/{codigoBarras}
|
***2. FINANÇA: COBRANÇA SICOOB: QUEM NUMERA O BOLETO (0=O SISTEMA / 1= O BANCO):*** Será utilizada para definição de quem vai numerar o boleto.
**Obs: Os Headers seguirão um padrão para todas as APIs.
[Headers e requisição de exemplo](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/sandbox-homologacao#bkmrk-exemplos-de-requisi%C3%A7 "Headers e requisição de exemplo")**
##### ***Questões Técnicas:***
***1.*** Configurações ficaram salvar na tabela do banco de dados **CD\_CONFIG\_CAMPO
*2.*** Configurações salvar pelo uusário, salvar na tabela **CD\_CONFIG\_DEFINE**
***3. SQL*** exemplo para alimentação da tabela no banco de dados
**(SUBSTITUIR OS CÓDIGO 700, 701, CONFORME O NECESSÁRIO, FORAM APENAS EXEMPLOS!!)**
```SQL
INSERT INTO CD_CONFIG_CAMPO ( CODIGO, DESCRICAO )
SELECT 700 AS Expr1, 'FINANCEIRO: AMBIENTE DE ENVIO BANCO SICOOB (0=HOMOLOGACAO(PADRAO)/1=PRODUCAO):' AS Expr2;
```
```SQL
INSERT INTO CD_CONFIG_CAMPO ( CODIGO, DESCRICAO )
SELECT 701 AS Expr1, 'FINANÇA: COBRANÇA SICOOB: QUEM NUMERA O BOLETO (0=O SISTEMA / 1= O BANCO):' AS Expr2;
```
***4.*** Além das configurações criadas, ainda se utilizarão de config já existentes, como:
**FINANÇA: INSTRUÇÃO DO BOLETO DE COB. LINHA 1**
**FINANÇA: INSTRUÇÃO DO BOLETO DE COB. LINHA 2**
- Entre outras que existem.
©SOFTEN SISTEMAS 2025
# PROC002 Preenchimento da Carteira
|
| **Projeto/Sistema:**
Emissão de Boletos - SIEM
| **Versão do *Template:***
1.1 |
| **Processo:**
PROC002 Preenchimento da Carteira | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
11/02/2025
|
##### **1. Introdução**
**Este processo visa exemplificar as configurações da carteira necessárias para utilização do banco Sicoob via API.**
#### **Processos Relacionados**
- - - - - -
[PROC001 Configurações](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/proc001-configuracoes "PROC001 Configurações")
[Endpoints Produção (Exemplos JSON)](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json "Endpoints Produção (Exemplos JSON)")
#### **Especificação Funcional**
- - - - - -
#### **PROC002 Preenchimento da Carteira:**
##### ***Protótipo de Tela:***
A configuração da carteira para a emissão também será preenchida junto com as os demais bancos (em Configurações > Financeiro > Carteira / Conta Mov.)
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739276986461.png)
*Imagem 1 - Configurações da Carteira*
##### ***Descrição dos Campos:***
***\*Campos seguem os mesmos padrões já estabelecidos no SIEM\****
| **Campo**
| **Tipo**
| **Tamanho**
| **Obrig. ?**
| **Máscara**
| **Observações**
|
| Banco
| Texto
| | Sim
| -
| -
|
| Chave da Aplicação
| Texto
| | Sim
| -
| Seria referente ao **Client ID**
|
| Token da Aplicação
| Texto
| | Sim
| -
| Seria referente ao **Acess Token (Bearer)**
|
##### [Sandbox - (homologação) - Credenciais de teste](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/sandbox-homologacao#bkmrk-1%29-acesse-suas-crede "Credenciais de teste")
##### ***Regras de Interface:***
***1. Regras do campo:*** Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2.
##### ***Regras de Negócio:***
***1. Regras de negócio:***
Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2..
##### ***Questões Técnicas:***
***1. Descrição de mudanças na base de dados, ou integração de API.*** Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2.
©SOFTEN SISTEMAS 2025
# PROC003 Eventos do Boleto
|
| **Projeto/Sistema:**
Emissão de Boletos - SIEM | **Versão do *Template:***
1.1 |
| **Processo:**
PROC003 Eventos do Boleto | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
11/02/2025
|
##### **1. Introdução**
**Este processo visa exemplificar a tela de integração com banco Sicoob, para consultar, registros, etc.**
#### **Processos Relacionados**
- - - - - -
[PROC001 Configurações](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/proc001-configuracoes "PROC001 Configurações")
[PROC002 Preenchimento da Carteira](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/proc002-preenchimento-da-carteira "PROC002 Preenchimento da Carteira")
#### **Especificação Funcional**
- - - - - -
#### **PROC003 Eventos do Boleto:**
##### ***Protótipo de Tela:***
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739286846569.png)
*Imagem 1 - Caminho para gerar arquivos de cobrança via API.*
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739284420459.png)
*Imagem 2 - Tela de eventos*
##### ***Regras de Interface:***
***1. Alteração no caminho para gerar arquivos de cobrança via API:*** Na **imagem 1**, seguir as mesmas regras já estebelecidas para integração via API BB, contudo, agora o nome ficará diferente, mais abrangente para outros bancos **Arquivo de Remessa Cobrança (Integração API).**
***2. Opção de selecionar carteira que são integradas via API:*** Na **imagem 2,** seguir as mesmas regras já estabelecidas para integração via API BB, contudo, agora ele deve permitir selecionar, as carteiras que são integrações via API, no exemplo teria **BB** e **SCB2 - SICOOB**.
##### ***Regras de Negócio:***
***1. Botão Cancelar Boletos:*** Deve realizar a requisição na API conforme especificado no [2.1.7 Serviço para comandar a baixa de boletos informados](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.29-servi%C3%A7o-para- "2.1.7 Serviço para comandar a baixa de boletos informados")
A requisição será realizada apenas para boletos que esteja com o status "Registrado".
***2. Alterar Boleto:*** Deve realizar a requisição na API, conforme especificado no [2.1.6 Serviço para alteração de dados de boleto já registrado.](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.25-servi%C3%A7o-para- "2.1.6 Serviço para alteração de dados de boleto já registrado.")
A requisição será realizada apenas para boletos que esteja com o status "Registrado".
***3. Imprimir Boletos:*** Deve realizar a requisição na API, conforme especificado no [2.1.4 Serviço para emissão da segunda via de boleto já registrado.](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.16-servi%C3%A7o-para- "2.1.4 Serviço para emissão da segunda via de boleto já registrado.")
A requisição será realizada apenas para boletos que esteja com o status "Registrado".
***4. Atualizar Status:*** Deve realizar a requisição na API, conforme especificado no [2.1.2 Serviço para consulta de um boleto bancário.](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-teste "2.1.2 Serviço para consulta de um boleto bancário.")
A requisição será realizada apenas para boletos que esteja com o status "A enviar".
***5. Registrar Boletos:*** Deve realizar a requisição na API, conforme especificado no [2.1.1 Serviço para a inclusão de boletos.](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-servi%C3%A7o-para-a "2.1.1 Serviço para a inclusão de boletos.")
A requisição será realizada apenas para boletos "A enviar" ou "A registrar",
##### ***Questões Técnicas:***
***1.** **Seguir o mesmo padrão existente hoje no SIEM para integração via API BB, nas tabelas do banco de dados.***
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739294950364.png)
***2. Dados a serem usados para teste em abiente de homologação, conforme:***
[Docs - Sandbox (Homologação)](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/sandbox-homologacao "Docs - Sandbox (Homologação)")
***3. Detalhes de cada enpoint relacionado a boletos:*** [Endppoints Produção (Exemplo JSON retornos)](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json "Endppoints Produção (Exemplo JSON retornos)")
©SOFTEN SISTEMAS 2025
# PROC004 Registro Automático de Boletos
|
| **Projeto/Sistema:**
Emissão de Boletos - SIEM
| **Versão do *Template:***
1.1 |
| **Processo:**
PROC004 Registro Automático de Boletos | **Versão do Documento:**
1.0 |
| **Responsável(eis):**
Gustavo Fernandes | **Data:**
11/02/2025
|
##### **1. Introdução**
**Este processo visa exemplificar as formas em que podemos gerar os boletos via API Sicoob no sistema de forma automática, assim como é feito com remessa.**
#### **Processos Relacionados**
- - - - - -
[PROC003 Eventos do Boleto](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/proc003-eventos-do-boleto "PROC003 Eventos do Boleto")
#### **Especificação Funcional**
- - - - - -
#### **PROC004 Registro Automático de Boletos:**
##### ***Protótipo de Tela:***
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739296809055.png)
*Imagem 1 - Emissão de Boleto no Pedido de Venda*
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739297121725.png)
*Imagem 2 - Emissão de Boleto na Nota Fiscal (config. 2)*
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739297386944.png)
*Imagem 3 - Emissão de Boleto pela tela de Duplicata a Receber*
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739298105406.png)
*Imagem 4 - Opção Reemitir Boleto*
##### ***Regras de Interface:***
***1. Regras do campo:*** Seguir o mesmo padrão já estabelecido no SIEM para remessas de boleto.
##### ***Regras de Negócio:***
***1. Pedido de venda (Imagem 1):***
Será realizado o envio do boleto para registro quando o usuário marcar "**Boleto**" na opção **Emitir ao Finalizar** e selecionar uma carteira configurada com a opção **SCB2** para emissão.
Ao clicar em confirmar, deve ser realizada a requisição de [Registro dos boletos](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-servi%C3%A7o-para-a "Registro dos boletos") para cada parcela gerada.
Caso sejam registrados com sucesso, deve ser gerado o PDF de cada boleto.
**Se não** registrar alguma parcela, deve retornar o status e uma mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: **Retorno do banco**"
***2. Nota Fiscal (Imagem 2):*** Deve realizar o envio dos boletos para envio quando estiver habilitada a **configuração:**
**"FATURAMENTO: GERAR BOLETO (A RECEBER) AO FINALIZAR NFE (0=NÃO/1=SIM):".**
O usuário deve fazer o preenchimento das parcelas na NFe, finaliza-la, clicar em **"Sim"** na mensagem de confirmação **(conforme o exemplo abaixo)** e selecionar uma carteira configurada com a opção **SCB2** para emissão.
[](https://docs.softensistemas.com.br/uploads/images/gallery/2025-02/image-1739361601166.png)
Ao clicar em confirmar, deve ser realizada a requisição de [Registro dos boletos](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-servi%C3%A7o-para-a "Registro dos boletos"), para cada parcela preenchida.
Caso sejam registrados com **sucesso**, deve ser gerado o PDF de cada boleto.
Caso **contrário**, deve-se retornar uma mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: **Retorno do banco**"
****3. Duplicata a Receber (Imagem 3):**** Quando for selecionada uma carteira configurada com a opção **SCB2** para emissão e o usuário marcar a opção
**"Emitir Boleto"**, deve ser realizada a requisição de [Registro dos boletos.](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-servi%C3%A7o-para-a "Registro dos boletos.")
Se estiver preenchido para repetir lançamentos para mais parcelas, deve ser realizado um envio para cada uma.
Após serem registrados, deve ser gerado o PDF de cada boleto.
Se **não** forem registradas, retornar mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: **Retorno do banco**"
***4. Tela de Consulta Duplicatas a Receber (Imagem 4):*** Quando o usuário clicar na opção **"Reemitir Boleto"** e selecionar uma carteira que esteja configurada com a opção **SCB2** para emissão, deve ser realizada a requisição para [registro dos boletos](https://docs.softensistemas.com.br/books/integracao-banco-sicoob-via-api/page/endpoints-producao-exemplos-json#bkmrk-2.1.1-servi%C3%A7o-para-a "registro dos boletos") selecionados.
***5.*** Para que as requisições de registro sejam realizadas, o status de cada Conta a Receber deve ser **"A enviar"**.
***6.*** Para que as requisições de geração do PDF sejam realizadas, os status devem estar como "Registrado".
***7.*** Quando se tratar de edição de alguma das formas mencionadas e o boleto já estiver registrado, deve ser realizada apenas a requisição de Geração do PDF novamente para o usuário.
##### ***Questões Técnicas:***
***1. Descrição de mudanças na base de dados, ou integração de API, ou arquivo que deva ser gerado.***
©SOFTEN SISTEMAS 2025