SIEM | Boleto
- Emissão Banco do Brasil - Via API
- Carteira Sicredi
- Carteira Caixa Econômica Federal
- Carteira Sicoob
- Emitir Boleto Pelo A Receber
- Como Gerar o Arquivo de Remessa
- Como importar o Arquivo de Retorno
- Emissão Sicoob - Via API
Emissão Banco do Brasil - Via API
Primeiros Passos - Liberação
Cadastro no Portal
Primeiro é necessário possuir uma conta no "Portal Developers BB".
Clique na opção "Cadastre-se" para criar o acesso.
Será necessário fazer o preenchimento de um CPF (pode ser qualquer pessoa responsável pela empresa).
Em seguida deverão ser preenchidos o nome da mãe, data de nascimento, endereço de e-mail e número de celular válidos.
Após o preenchimento das informações, será enviado um Código de Confirmação para o número de telefone cadastrado.
Ao informar o código enviado para o telefone, será solicitado para cadastrar uma senha (conforme as instruções).
É necessário assinar os termos solicitados.
Criação da Aplicação
Após realizar o acesso no portal clique na opção "NOVA APLICAÇÃO".
Preencha os campos Nome da Aplicação (ex: Soften SIEM, Gerencie Aqui...) e Descrição. Os dados serão apenas para identificação, logo não possui um padrão a ser seguido.
Não é obrigatório fazer o preenchimento o Ícone da Aplicação.
Por fim, selecione a API de integração que será utilizada. Expanda o grupo "APIs com contratação online pelo Portal Developers BB" e maque a opção "Cobranças".
Depois do preenchimento de todos os passos anteriores, clique em "CRIAR"
Importante!
Após a criação de uma nova API seu status será "Em teste", conforme a imagem a seguir. Portanto apenas esse ambiente estará liberado para o envio de boletos. Depois será necessário solicitar a liberação do ambiente de produção.
*Não é obrigatório realizar a emissão de boletos em homologação para solicitar o ambiente de produção. Ficará a critério da empresa.
Credenciais para ambiente de Homologação
Com a Aplicação criada, clique sobre ela para acessar a área do desenvolvedor.
No Menu lateral, clique na opção "Credenciais".
Para realizarmos as configurações no sistema serão necessárias as informações developer_application_key e o Basic do Authorization (clicando no botão "Basic" ao final da página).
Utilize essas informações para configuração do sistema, conforme a documentação de "Configurações e Emissão".
Solicitação do ambiente de produção
Preencha o CNPJ da empresa e confirme os dados:
Revise os dados a aplicação e clique em "SOLICITAR PRODUÇÃO".
Importante!
Para a API de cobrança pode ser necessário ou não a interferência do banco no processo.
Se a empresa já possuir um convênio de cobrança ativo contratado para o CNPJ a liberação será feita automaticamente.
Caso contrário será necessário aguardar o contato do Banco do Brasil para a contratação de um convênio de cobrança. Enquanto isso a aplicação ficará com o status "Aguardando Aprovação".
Assim que for liberado o ambiente de produção, a aplicação ficará com o status "Aprovado".
Credenciais para ambiente de Produção
As credenciais para o ambiente de produção não são as mesmas de homologação. Acesse o menu "Credenciais" e confira se o ambiente selecionado (em azul) é "Produção".
As informações necessárias para a configuração do sistema são developer_application_key e Basic do Authorization (clicar no botão "Copiar Basic").
Configurações e Emissão
Configuração do Ambiente de Emissão
Definir o ambiente de emissão na Config. 2:
FINANCEIRO: AMBIENTE DE ENVIO BANCO DO BRASIL (0=HOMOLOGACAO(PADRAO)/1=PRODUCAO):
Configuração da Carteira
Em Cadastros > Financeiro > Carteira / Conta Mov. cadastre uma nova carteira e selecione a opção "BB2 - Integração BB" em "Banco".
É necessário fazer o preenchimento das credenciais* geradas no Portal Developers do Banco do Brasil. Caso não possua as credenciais, veja como gerar na documentação de "Primeiros Passos - Liberação".
Chave da Aplicação - Preencha com a developer_application_key (de homologação ou produção) gerada no portal de desenvolvedores.
Token da Aplicação - Deve ser preenchido com a o Basic do Authorization (de homologação ou produção) gerada também no portal.
O restante das informações deve ser preenchido normalmente para a emissão de boletos, conforme os campos em destaque (em amarelo).
Emissão de Boletos
Para realizar o registro de um boleto, é necessário possuir os lançamentos nas "Contas a Receber" (duplicatas).
As operações com os boletos são acessadas em Financeiro > Relatórios (menu lateral) > Arquivo de Remessa Cobrança BB2.
É possível filtrar as duplicatas geradas por período (data de vencimento ou data de geração), carteiras e cliente.
*Nessa tela serão listadas apenas as carteiras do tipo "BB2 - Integração BB".
Selecione os títulos para registro e clique em "Registrar Boletos". Irá abrir uma tela com a o status do registro do boleto.
Para visualizar os boletos que foram registrados é necessário marcar a caixa "Mostrar registrados".
Após o registro, marque novamente os títulos e clique em "Imprimir Boletos". Será feito o download do PDF.
Para as liquidações de boletos é necessário clicar na opção "Atualizar Status". A consulta dos títulos será feita de acordo com o período selecionado.
Carteira Sicredi
Cadastro Carteira BANCO SICREDI
1- Clicar na opção Exibir Menu Completo, Cadastros, Financeiro, Carteira/Conta Mov.
2- Digite o nome do banco, marque a opção emitir boleto, depois clique em salvar.
3- Na opção dados da conta selecione o banco Sicredi, preencha todas as informações dos campos amarelos que são os principais. As informações de Cód. Empresa, Posto e Instrução precisam ser fornecidas pelo setor responsável pela homologação de boletos do banco Sicredi.
Carteira Caixa Econômica Federal
Carteira Caixa Econômica Federal
Cadastro Carteira Banco Caixa Econômica Federal
1- Clicar na opção Exibir Menu Completo, Cadastros, Financeiro, Carteira/Conta Mov.
2- Digite o nome do banco, marque a opção emitir boleto, depois clique em salvar.
3- Na opção dados da conta selecione o banco Caixa, preencha todas as informações dos campos amarelos que são os principais. As informações de Cód. Empresa, Instrução 1 e Instrução 2 precisam ser fornecidas pelo setor responsável pela homologação de boletos do banco Caixa.
Carteira Sicoob
Cadastro Carteira Banco Sicoob
1- Clicar na opção Exibir Menu Completo, Cadastros, Financeiro, Carteira/Conta Mov.
2- Digite o nome do banco, marque a opção emitir boleto, depois clique em salvar.
3- Na opção dados da conta selecione o banco Sicoob, preencha todas as informações dos campos amarelos que são os principais. As informações de Cód. Empresa, Instrução 1 e Instrução 2 precisam ser fornecidas pelo setor responsável pela homologação de boletos do banco Sicoob.
Emitir Boleto Pelo A Receber
Independente da forma escolhida para gerar um titulo. Ambas estarão na opção A Receber, escolha como deseja localizar o titulo Por Período ou Por Cliente.
No modo a receber, temos a consulta por período em que os títulos são listados através de um determinado período, conforme o exemplo:
Selecione o título que deseja emitir o boleto, clicando na caixinha do lado esquerdo. Em seguida clique no botão Reemitir Boleto. (Obs: Caso você queira emitir mais de um boleto, marque dois ou mais títulos na caixinha a esquerda.)
Aparecera um tela onde você irar escolher a carteira que deseja emitir o boleto.
Você pode também localizar o título por período e clicar duas vezes em cima da duplicata para abri-la.
Na seguinte tela, marque a opção Emitir Boleto e clique no botão Finalizar.
Como Gerar o Arquivo de Remessa
Para gerar o arquivo de remessa no Soften Siem, vamos em Financeiro/ Relatórios/ Arquivo de Remessa Cobrança.
Em seguida vamos filtrar os títulos pelo o período selecionando a data que o título foi gerado ou pela data de vencimento do título. No campo Banco e Carteira, localize o Banco a qual deseja emitir o boleto, e depois clique em Listar Títulos a Registrar.
Logo em seguida vai aparecer todos os títulos a registrar de acordo com o filtro que você utilizou.
Marque os títulos que deseja gerar o arquivo de remessa ou clique na opção Selecionar todos os títulos.
Clique no botão Gerar Arquivo para gerar a remessa
Em seguida aparecera uma confirmação da quantidade de remessa gerada. Clique em OK para encerar
Os arquivos salvos vão para a pasta selecionada neste campo abaixo
Você pode editar o caminho sempre que precisar ou deixar um pré-fixado dentro da carteira conforme a baixo.
Depois aparecera uma tela com um relatório
Como importar o Arquivo de Retorno
Para importar o arquivo de retorno do banco no Soften Siem, vamos em Financeiro/ A receber/ Baixa de Recebimento.
Em seguida, vamos selecionar qual banco vamos importar o retorno no sistema.
Depois de selecionar qual o banco que você vai importar o retorno. Vai pedir para você localizar o arquivo que você baixou no internet banking do banco e importar no sistema.
Selecione o arquivo e clique em Abrir.
Em seguida, o sistema abrirá uma tela de mensagem: Importado com sucesso! Confira o relatório
Clique em ok para visualizar o relatório com as informações de registro ou de liquidez dos boletos em abertos.
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)
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".
Será necessário preencher todos os dados para cadastro, inclusive o CPF do representante da empresa.
Gerar Aplicativo (Ambiente produção):
Após realizar o acesso, cadastrando-se no portal, será necessário criar um novo aplicativo junto ao cliente.
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)
2. Seguir o passo a passo conforme documentação:
Passo a passo criação aplicativo
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
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.
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
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
API Cobrança Bancária Pagamentos:
https://sandbox.sicoob.com.br/sicoob/sandbox/cobranca-bancaria-pagamentos/v3
API Conta Corrente:
https://sandbox.sicoob.com.br/sicoob/sandbox/conta-corrente/v4
API Convênios Pagamentos:
https://sandbox.sicoob.com.br/sicoob/sandbox/convenios-pagamentos/v2
API Investimentos - RDC:
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
API Pix Pagamentos:
https://sandbox.sicoob.com.br/sicoob/sandbox/pix-pagamentos/v2
API Pix Recebimentos:
https://sandbox.sicoob.com.br/sicoob/sandbox/pix/api/v2
API Poupança:
https://sandbox.sicoob.com.br/sicoob/sandbox/poupanca/v3
API SPB Transferências:
https://sandbox.sicoob.com.br/sicoob/sandbox/spb/v2
Exemplos de requisição
Consultar Cobrança Imediata PIX
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
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
Especificação Funcional
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
Questões Técnicas:
1. Cobrança Bancária Pagamentos
BASE URL: 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:
1.1.2 Resposta esperada:
Code |
Description |
200 |
OK |
1.1.3 Exemplo retorno:
{
"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"
}
}
1.1.4 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. |
1.1.5 Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
1.1.6 Serviço para efetuar o pagamento ou agendamento de boleto.
Método HTTP |
URL |
POST |
/boletos/pagamentos/{codigoBarras} |
Parâmetros:
Exemplo valor | Modelo: (boletoPagamento)
{
"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
}
}
1.1.7 Resposta esperada:
Code |
Description |
200 |
OK |
1.1.8 Exemplo retorno:
{
"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"
}
}
1.1.9 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. |
1.1.10 Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
1.1.11 Serviço para consultar um comprovante de um pagamento efetuado.
Método HTTP |
URL |
GET |
/boletos/pagamentos/{idPagamento}/comprovantes |
Parâmetros:
1.1.12 Resposta esperada:
Code |
Description |
200 |
OK |
1.1.13 Exemplo retorno:
{
"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"
}
}
1.1.14 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. |
1.1.15 Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
1.1.16 Serviço para cancelar um agendamento de pagamento.
Método HTTP |
URL |
DELETE |
/boletos/pagamentos/agendamentos/{idPagamento} |
Parâmetros:
Exemplo valor | Modelo: (cancelamento)
{
"numeroConta": 1234569
}
1.1.17 Resposta esperada:
Code |
Description |
204 |
Requisição processada com sucesso e não há conteúdo a ser retornado. |
1.1.18 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 |
1.1.19 Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
1.1.20 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:
1.1.21 Resposta esperada:
Code |
Description |
200 |
OK |
1.1.22 Exemplo retorno:
{
"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"
}
}
1.1.23 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. |
1.1.19 Exemplo retorno: (Mesmo padrão de retorno para o 400, 406 e 500)
{
"mensagens": [
{
"mensagem": "string",
"codigo": "string"
}
]
}
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.
Acesso para conferir o catalógo completo das API's:
Catálogo de API's
©SOFTEN SISTEMAS 2024