Cobrança - bs2.pj.forIntegration - Versão: 1

Cobrança

O que é API de Cobrança ?

API Cobrança disponibiliza operações relacionadas a emissão de boletos, permitindo acompanhar o ciclo de vida de um boleto:

Quem pode usar a API de Cobrança

Todos os clientes e parceiros do banco BS2.

Quais são requisitos para a utilização da API de Cobrança ?

Autenticação

Utilizamos em nossas API’s de autenticação um rate-limit, que permite até 10 requisições de Token e refresh por minuto, sendo necessário realizar o gerenciamento de token descrito abaixo:

Gerenciamento de Token

É necessário fazer a gestão do token de acesso e do refresh_token dentro da sua aplicação.

1.1 - Gerar um token utilizando ClientId, ClientSecret, username e password. Fluxo de geração de token descrito no passo acima. O token possui uma validade em segundos, apresentada no campo expires_in. 420 segundos em Sandbox e 300 segundos em Produção.

1.2 - Utilizando o refresh_token gerado no passo anterior, deve-se fazer o fluxo de refresh_token. Desta forma, não se deve utilizar usuário e senha para gerar novo token.

1.3 - Antes do refresh_token expirar (10 minutos de duração), é necessário renovar o token usando fluxo de refresh_token.

Pontos Importantes

Ao gerar um token utilizando username e password, deve-se apenas gerar novos tokens usando o fluxo de refresh_token (utilizando o refresh_token e não o username e password)

Só é necessário gerar um novo token, utilizando usuário e senha, caso não consiga realizar o fluxo de refresh_token.

O campo expires_in representa a validade do token em segundos, enquanto o token estiver válido, este token deve ser utilizado.

O refresh_token possui um tempo de validade maior que a validade do token (10 min), ou seja, mesmo se o token estiver inválido por tempo, e o refresh_token estiver válido, ainda é possível fazer o fluxo de Refresh_token para gerar um token válido.

Quando o token estiver próximo da validade, deve-se gerar um novo token, usando um refresh_token, para assim, receber um novo token valido pelo mesmo período de tempo.

Não há limite de requisições enquanto o token estiver válido.

Quando um novo token é gerado, o token anterior passa a ser inválido.

Token de Autenticação

Para usar a API é necessário obter o token de autenticação vinculado a um usuário BS2. Para e emissão do token de acesso reproduza os seguintes passos:

1.1 Realizar uma requisição Basic Auth no endpoint abaixo

1.2 Definir o valor password para o campo grant_type

1.3 Definir o valor apibanking para o campo scope

1.4 Inserir usuário e senha válidos nos campos de username e password

{
  "grant_type":"password",
  "scope":"apibanking",
  "username":"valid_username",
  "password":"valid_password"  
}
{
  "access_token": "seu_access_token_guid",
  "token_type": "tipo_de_token",
  "expires_in": "tempo_de_expiracao_em_segundos",
  "refresh_token": "seu_refresh_token_guid",
  "scope": "apibanking"
}

Parâmetros

Nome Localizado em Descrição Requerido
grant_type body Define o tipo de requisição Sim
scope body Define qual o escopo da requisição Sim
username body Inserir um usuário previamente cadastrado no banco BS2 Sim
password body Inserir uma senha válida referente ao usuário informado no campo acima Sim

Resposta

Código Descrição
200 Success
400 Bad Request
401 Unauthorized
  SandBox Produção
Requisições Solicitar URL ao time BS2 https://api.bs2.com:8443/auth/oauth/v2/token

Token de Atualização

Após a geração de um token de autenticação é recomendável que o gerenciamento do seu tempo de expiração seja feita pelo fluxo de atualização de token conforme os seguintes passos:

1.1 Realizar uma requisição Basic Auth no endpoint abaixo

1.2 Definir o valor refresh_token para o campo grant_type

1.3 Definir o valor apibanking para o campo scope

1.4 Definir o valor do refresh token recebido previamente para o campo refresh_token

{
  "grant_type": "refresh_token",
  "scope": "apibanking",
  "refresh_token": "refresh_token"
}
{
  "access_token": "seu_access_token_guid",
  "token_type": "tipo_de_token",
  "expires_in": "tempo_de_expiracao_em_segundos",
  "refresh_token": "seu_refresh_token_guid",
  "scope": "apibanking"
}

Parâmetros

Nome Localizado em Descrição Requerido
grant_type body Define o tipo de requisição Sim
scope body Define qual o escopo da requisição Sim
refresh_token body Inserir o refresh token recebido previamente Sim

Resposta

Código Descrição
200 Success
400 Bad Request
401 Unauthorized

Webhook de Boletos

O Banco BS2 disponibiliza um webhook para notificar os clientes em tempo real sobre os eventos que possam ocorrer em seus boletos. Para utilizar o webhook, por favor entre em contato com a equipe do BS2 informando uma URL para que possamos ativar o webhook para você. No momento essa operação é feita apenas manualmente, sendo necessária a solicitação para a equipe Tech do BS2 Empresas.

Funcionamento

O webhook será disparado via uma requisição HTTP POST até que o cliente retorne com um status de sucesso (família HTTP 200).

Contrato

Para cada evento que ocorra em um boleto, um webhook é disparado com a devida informação. Abaixo segue o contrato que será enviado a cada requisição com os dados do boleto e do evento.

{
   "Id":"f3ac8876-5fcb-4dbd-868d-fb5ce76b4af7",
   "Conta":123456,
   "DataNotificacao":"2019-07-12T15:14:17.1724178-03:00",
   "NossoNumeroBoleto":10016587895,
   "SeuNumeroBoleto":"12345",
   "Valor":1000,
   "ValorLiquidado":1000,
   "SituacaoDescricao":"Qualquer valor liquidado independentemente da data do pagamento",
   "Situacao":4,
   "StatusBoleto":[
      {
         "Status":1,
         "Descricao":"Boleto registrado no órgão responsável.",
         "DataStatus":"2019-10-02T22:23:34.9351562-03:00"
      },
      {
         "Status":2,
         "Descricao":"O boleto foi pago com sucesso.",
         "DataStatus":"2019-10-07T07:30:04.9036831-03:00"
      }
   ]
}

Descrição dos campos do modelo principal

Abaixo segue tabela descritiva dos campos enviados na notificação:

Campo Descrição
Id Código único da notificação
DataNotificacao Data do disparo do webhook ao parceiro
NossoNumeroBoleto Define o valor do campo nosso número do boleto.
SeuNumeroBoleto Campo seu número enviado no momento da criação do boleto.
Valor Valor do boleto. O valor pago pode ser diferente (multa/desconto).
ValorLiquidado Informa o valor que foi pago pelo cliente, se o boleto tiver sido pago.
StatusBoleto Matriz com o histórico de status do boleto [Vide tabela abaixo]
Situacao Situação do boleto [Vide tabela abaixo]
SituacaoDescricao Descrição da situação do boleto

Código da situação - (Status do Boleto)

Abaixo seguem as situações existentes atualmente e seu significado:

Situação Descrição
1 Boleto em aberto - A vencer
2 Boleto em aberto - Vencido
3 Boleto Cancelado / Baixado
4 Boleto Liquidado / Compensado

Descrição dos campos do modelo status boleto

A cada novo EVENTO que ocorre com os boletos, enviamos via webhook as informações - abaixo está descrito como ‘status’ cada evento deste.

Abaixo segue a tabela descritiva dos campos enviados no item StatusBoleto

Campo Descrição
Status Código do status - evento [Vide tabela abaixo]
Descricao Descrição do status
DataStatus Data em que o fato ocorreu

Código do status - Eventos

Abaixo seguem os eventos informados atualmente e seu significado:

Status Descrição
1 Boleto Registrado junto ao órgão responsável - CIP
2 Identificado pagamento do boleto na rede bancária (*)
3 Boleto liquidado/compensado - crédito feito na CC (*)
4 Boleto cancelado/baixado (sem movimentação financeira)

(*) Importante ressaltar que o processo onde é efetivamente identificado o pagamento e recebimento do valor junto ao BS2, é no “Evento 3 - Boleto liquidado/compensado - crédito feito na CC”. O processo entre o pagamento do boleto na rede bancária (evento 2) e a compensação efetiva do boleto, podem existir problemas que impedem o recebimento do valor do boleto junto ao BS2, onde muitas vezes o BS2 não tem poder de atuação.

É importante identificar dentro da sua operação, qual a maneira ideal e mais segura de se beneficiar de cada evento deste informado.

Automatize seu processo com segurança!

Incluir Boleto de Cobrança


{
 "seuNumero": "string",
 "cliente": {
  "clienteId": "string",
  "telefone": "string",
  "email": "string",
  "tipo": [1, 2],
  "documento": "string",
  "nome": "string",
  "endereco": {
   "cep": "string",
   "estado": "string",
   "cidade": "string",
   "bairro": "string",
   "logradouro": "string",
   "numero": "string",
   "complemento": "string"
  }
 },
 "sacadorAvalista": {
  "tipo": [1, 2],
  "documento": "string",
  "nome": "string",
  "endereco": {
   "cep": "string",
   "estado": "string",
   "cidade": "string",
   "bairro": "string",
   "logradouro": "string",
   "numero": "string",
   "complemento": "string"
  }
 },
 "vencimento": "2021-4-11T21:18:57.405Z",
 "valor": 0,
 "canal": "string",
 "multa": {
  "valor": 0,
  "data": "2021-4-11T21:18:57.405Z",
  "juros": 0
 },
 "desconto": {
  "percentual": 0,
  "valorFixo": 0,
  "valorDiario": 0,
  "limite": "2021-4-11T21:18:57.405Z"
 },
 "mensagem": {
  "linha1": "string",
  "linha2": "string",
  "linha3": "string",
  "linha4": "string"
 },
 "aceite": false,
 "especie": "string"
}

{
 "id": "string",
 "sacado": {
  "email": "string",
  "telefone": "string",
  "tipo": [1, 2],
  "documento": "string",
  "nome": "string",
  "endereco": {
   "cep": "string",
   "estado": "string",
   "cidade": "string",
   "bairro": "string",
   "logradouro": "string",
   "numero": "string",
   "complemento": "string"
  }
 },
 "status": [1, 2, 3, 4],
 "nossoNumero": 0,
 "codigoDeBarra": "string",
 "linhaDigitavel": "string",
 "seuNumero": "string",
 "clienteId": "string",
 "sacadorAvalista": {
  "tipo": [1, 2],
  "documento": "string",
  "nome": "string",
  "endereco": {
   "cep": "string",
   "estado": "string",
   "cidade": "string",
   "bairro": "string",
   "logradouro": "string",
   "numero": "string",
   "complemento": "string"
  }
 },
 "vencimento": "2021-4-11T21:18:57.405Z",
 "valor": 0,
 "canal": "string",
 "multa": {
  "valor": 0,
  "data": "2021-4-11T21:18:57.405Z",
  "juros": 0
 },
 "desconto": {
  "percentual": 0,
  "valorFixo": 0,
  "valorDiario": 0,
  "limite": "2021-4-11T21:18:57.405Z"
 },
 "mensagem": {
  "linha1": "string",
  "linha2": "string",
  "linha3": "string",
  "linha4": "string"
 },
 "aceite": false,
 "especie": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.cobranca.boletos.criarBoletoSimplificado.CriarBoletoSimplificado

Resposta

Código Descrição Schema
201 Success bs2.pj.cobranca.boletos.compartilhados.BoletoCriado
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Listar Boletos com Filtros


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos"

{
 "itens": [
   {
    "item": {
     "id": "string",
     "nossoNumero": 0,
     "seuNumero": "string",
     "valor": 0,
     "valorLiquidado": 0,
     "vencimento": "2021-4-11T21:18:57.405Z",
     "emissao": "2021-4-11T21:18:57.405Z",
     "notificacaoPagamento": "2021-4-11T21:18:57.405Z",
     "pagamento": "2021-4-11T21:18:57.405Z",
     "cancelamento": "2021-4-11T21:18:57.405Z",
     "canal": "string",
     "nomeSacado": "string",
     "codigoBarras": "string",
     "linhaDigitavel": "string",
     "registrado": false,
     "status": [1, 2, 3, 4]
    },
    "links": [
      {
       "href": "string",
       "type": "string"
      }
    ]
   }
 ],
 "inicio": 0,
 "limite": 0,
 "total": 0
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
inicio query   Não long
limite query   Não long
emissaoInicial query   Não dateTime
emissaoFinal query   Não dateTime
vencimentoInicial query   Não dateTime
vencimentoFinal query   Não dateTime
status query   Não bs2.pJ.apis.queries.compartilhados.boletos.StatusBoleto
documentoSacado query   Não string
canal query   Não string
seuNumero query   Não string
nossoNumero query   Não long

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.obterBoletos.PaginaBoletoBuscadoHateoas
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Boleto de Cobrança (por código identificador)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{boletoId}"

{
 "item": {
  "id": "string",
  "nossoNumero": 0,
  "seuNumero": "string",
  "valor": 0,
  "valorPago": 0,
  "valorLiquidado": 0,
  "carteira": {
   "descricao": "string",
   "codigo": 0
  },
  "movimento": "2021-4-11T21:18:57.405Z",
  "vencimento": "2021-4-11T21:18:57.405Z",
  "emissao": "2021-4-11T21:18:57.405Z",
  "notificacaoPagamento": "2021-4-11T21:18:57.405Z",
  "pagamento": "2021-4-11T21:18:57.405Z",
  "cancelamento": "2021-4-11T21:18:57.405Z",
  "canal": "string",
  "sacado": {
   "email": "string",
   "telefone": "string",
   "tipo": [1, 2],
   "documento": "string",
   "nome": "string",
   "endereco": {
    "cep": "string",
    "estado": "string",
    "cidade": "string",
    "bairro": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string"
   }
  },
  "sacadorAvalista": {
   "tipo": [1, 2],
   "documento": "string",
   "nome": "string",
   "endereco": {
    "cep": "string",
    "estado": "string",
    "cidade": "string",
    "bairro": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string"
   }
  },
  "codigoBarras": "string",
  "linhaDigitavel": "string",
  "registrado": false,
  "mensagem": {
   "linha1": "string",
   "linha2": "string",
   "linha3": "string",
   "linha4": "string"
  },
  "desconto": {
   "percentual": 0,
   "valorFixo": 0,
   "valorDiario": 0,
   "limite": "2021-4-11T21:18:57.405Z"
  },
  "multa": {
   "valor": 0,
   "data": "2021-4-11T21:18:57.406Z",
   "juros": 0
  },
  "status": [1, 2, 3, 4],
  "naturezaDaOperacaoDePagamento": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 99]
 },
 "links": [
   {
    "href": "string",
    "type": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
boletoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.compartilhados.BoletoBuscadoHateoas
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Boleto de Cobrança (por nosso número)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{nossoNumero}"

{
 "item": {
  "id": "string",
  "nossoNumero": 0,
  "seuNumero": "string",
  "valor": 0,
  "valorPago": 0,
  "valorLiquidado": 0,
  "carteira": {
   "descricao": "string",
   "codigo": 0
  },
  "movimento": "2021-4-11T21:18:57.406Z",
  "vencimento": "2021-4-11T21:18:57.406Z",
  "emissao": "2021-4-11T21:18:57.406Z",
  "notificacaoPagamento": "2021-4-11T21:18:57.406Z",
  "pagamento": "2021-4-11T21:18:57.406Z",
  "cancelamento": "2021-4-11T21:18:57.406Z",
  "canal": "string",
  "sacado": {
   "email": "string",
   "telefone": "string",
   "tipo": [1, 2],
   "documento": "string",
   "nome": "string",
   "endereco": {
    "cep": "string",
    "estado": "string",
    "cidade": "string",
    "bairro": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string"
   }
  },
  "sacadorAvalista": {
   "tipo": [1, 2],
   "documento": "string",
   "nome": "string",
   "endereco": {
    "cep": "string",
    "estado": "string",
    "cidade": "string",
    "bairro": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string"
   }
  },
  "codigoBarras": "string",
  "linhaDigitavel": "string",
  "registrado": false,
  "mensagem": {
   "linha1": "string",
   "linha2": "string",
   "linha3": "string",
   "linha4": "string"
  },
  "desconto": {
   "percentual": 0,
   "valorFixo": 0,
   "valorDiario": 0,
   "limite": "2021-4-11T21:18:57.406Z"
  },
  "multa": {
   "valor": 0,
   "data": "2021-4-11T21:18:57.406Z",
   "juros": 0
  },
  "status": [1, 2, 3, 4],
  "naturezaDaOperacaoDePagamento": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 99]
 },
 "links": [
   {
    "href": "string",
    "type": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
nossoNumero path   Sim long

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.compartilhados.BoletoBuscadoHateoas
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Gera Boleto de Cobrança PDF (por código identificador)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{boletoId}/imprimivel"

string

Parâmetros

Nome Localizado em Descrição Requerido Schema
boletoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success byte
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Gera Boleto de Cobrança PDF (por nosso número)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{nossoNumero}/imprimivel"

string

Parâmetros

Nome Localizado em Descrição Requerido Schema
nossoNumero path   Sim long

Resposta

Código Descrição Schema
200 Success byte
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Solicita Novo Vencimento do boleto (por nosso número)


{
 "vencimento": "2021-4-11T21:18:57.406Z"
}

{
 "solicitacaoId": "string",
 "nossoNumero": 0,
 "status": [1, 2, 3]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoVencimento
nossoNumero path   Sim long

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoVencimentoPorNossoNumero
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Solicita Novo Vencimento do boleto (por código identificador)


{
 "vencimento": "2021-4-11T21:18:57.406Z"
}

{
 "solicitacaoId": "string",
 "boletoId": "string",
 "status": [1, 2, 3]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoVencimento
boletoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoVencimentoPorId
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Solicitação de Novo Vencimento do boleto (por nosso número)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{nossoNumero}/solicitacoes/novosvencimentos/{solicitacaoId}"

{
 "solicitacaoId": "string",
 "nossoNumero": 0,
 "status": [1, 2, 3],
 "vencimento": "2021-4-11T21:18:57.406Z"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
nossoNumero path   Sim long
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoVencimentoPorNossoNumero
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Solicitação de Novo Vencimento do boleto (por código identificador)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{boletoId}/solicitacoes/novosvencimentos/{solicitacaoId}"

{
 "solicitacaoId": "string",
 "boletoId": "string",
 "status": [1, 2, 3],
 "vencimento": "2021-4-11T21:18:57.406Z"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
boletoId path   Sim string (uuid)
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoVencimentoPorId
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Solicita Cancelamento de Boleto (por código identificador)


{
 "justificativa": "string"
}

{
 "solicitacaoId": "string",
 "boletoId": "string",
 "status": [1, 2, 3],
 "justificativa": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoCancelamento
boletoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoCancelamentoPorId
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Solicita Cancelamento de Boleto (por nosso número)


{
 "justificativa": "string"
}

{
 "solicitacaoId": "string",
 "nossoNumero": 0,
 "status": [1, 2, 3],
 "justificativa": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoCancelamento
nossoNumero path   Sim long

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoCancelamentoPorNossoNumero
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]
404 Not Found [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Solicitação de Cancelamento de Boleto (por código identificador)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{boletoId}/solicitacoes/cancelamentos/{solicitacaoId}"

{
 "solicitacaoId": "string",
 "boletoId": "string",
 "status": [1, 2, 3]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
boletoId path   Sim string (uuid)
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoCancelamentoPorId
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Consulta Solicitação de Cancelamento de Boleto (por nosso número)


--curl
"GET": "/pj/forintegration/cobranca/v1/boletos/{nossoNumero}/solicitacoes/cancelamentos/{solicitacaoId}"

{
 "solicitacaoId": "string",
 "nossoNumero": 0,
 "status": [1, 2, 3]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
nossoNumero path   Sim long
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoCancelamentoPorNossoNumero
400 Bad Request [ bs2.pJ.sharedKernel.responseResult.DetalheBadRequest ]

Models

DetalheBadRequest

bs2.pJ.sharedKernel.responseResult.DetalheBadRequest

Nome Tipo Descrição Tamanho Requerido
tag string   - Não
descricao string   - Não

NovaSolicitacaoNovoVencimento

bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoVencimento

Nome Tipo Descrição Tamanho Requerido
vencimento dateTime   - Não

StatusSolicitacao

bs2.pj.cobranca.boletos.solicitacoes.StatusSolicitacao

Nome Tipo Descrição Tamanho Requerido
bs2.pj.cobranca.boletos.solicitacoes.StatusSolicitacao integer   -  

SolicitacaoNovoVencimentoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoVencimentoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não

SolicitacaoNovoVencimentoPorId

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoVencimentoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não

TipoPessoa

bs2.pj.compartilhados.TipoPessoa

Nome Tipo Descrição Tamanho Requerido
bs2.pj.compartilhados.TipoPessoa integer   -  

Endereco

bs2.pj.compartilhados.Endereco

Nome Tipo Descrição Tamanho Requerido
cep string   8 Não
estado string   2 Não
cidade string   30 Não
bairro string   50 Não
logradouro string   100 Não
numero string   8 Não
complemento string   50 Não

SacadoNomeEndereco

bs2.pj.cobranca.boletos.solicitacoes.SacadoNomeEndereco

Nome Tipo Descrição Tamanho Requerido
email string   - Não
telefone string   - Não
enderecoObrigatorio boolean   - Não
tipo enum 1, 2 - Não
documento string   - Não
nome string   - Não
endereco bs2.pj.compartilhados.Endereco   - Não

NovaSolicitacaoNovoSacado

bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoSacado

Nome Tipo Descrição Tamanho Requerido
sacado bs2.pj.cobranca.boletos.solicitacoes.SacadoNomeEndereco   - Não

SolicitacaoNovoSacadoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoSacadoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não

SolicitacaoNovoSacadoPorId

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoSacadoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não

NovaSolicitacaoNovoCancelamento

bs2.pj.cobranca.boletos.solicitacoes.NovaSolicitacaoNovoCancelamento

Nome Tipo Descrição Tamanho Requerido
justificativa string   500 Não

SolicitacaoNovoCancelamentoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoCancelamentoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não
justificativa string   - Não

SolicitacaoNovoCancelamentoPorId

bs2.pj.cobranca.boletos.solicitacoes.SolicitacaoNovoCancelamentoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não
justificativa string   - Não

ObterSolicitacaoNovoVencimentoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoVencimentoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não
vencimento dateTime   - Não

ObterSolicitacaoNovoVencimentoPorId

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoVencimentoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não
vencimento dateTime   - Não

Sacado

bs2.pj.cobranca.boletos.solicitacoes.Sacado

Nome Tipo Descrição Tamanho Requerido
email string   - Não
telefone string   - Não
enderecoObrigatorio boolean   - Não
tipo enum 1, 2 - Não
documento string   14 Não
nome string   150 Não
endereco bs2.pj.compartilhados.Endereco   - Não

ObterSolicitacaoNovoSacadoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoSacadoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não
sacado bs2.pj.cobranca.boletos.solicitacoes.Sacado   - Não

ObterSolicitacaoNovoSacadoPorId

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoSacadoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não
sacado bs2.pj.cobranca.boletos.solicitacoes.Sacado   - Não

ObterSolicitacaoNovoCancelamentoPorNossoNumero

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoCancelamentoPorNossoNumero

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
nossoNumero long   - Não
status enum 1, 2, 3 - Não

ObterSolicitacaoNovoCancelamentoPorId

bs2.pj.cobranca.boletos.solicitacoes.ObterSolicitacaoNovoCancelamentoPorId

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
boletoId string (uuid)   - Não
status enum 1, 2, 3 - Não

StatusBoleto

bs2.pJ.apis.queries.compartilhados.boletos.StatusBoleto

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.apis.queries.compartilhados.boletos.StatusBoleto integer   -  

StatusBoleto

bs2.pj.cobranca.boletos.compartilhados.StatusBoleto

Nome Tipo Descrição Tamanho Requerido
bs2.pj.cobranca.boletos.compartilhados.StatusBoleto integer   -  

BoletoBuscadoResumido

bs2.pj.cobranca.boletos.obterBoletos.BoletoBuscadoResumido

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
nossoNumero long   - Não
seuNumero string   - Não
valor double   - Não
valorLiquidado double   - Não
vencimento dateTime   - Não
emissao dateTime   - Não
notificacaoPagamento dateTime   - Não
pagamento dateTime   - Não
cancelamento dateTime   - Não
canal string   - Não
nomeSacado string   - Não
codigoBarras string   - Não
linhaDigitavel string   - Não
registrado boolean   - Não
status enum 1, 2, 3, 4 - Não

LinkHateoas

bs2.pj.cobranca.boletos.compartilhados.LinkHateoas

Nome Tipo Descrição Tamanho Requerido
href string   - Não
type string   - Não

BoletoBuscadoHateoas

bs2.pj.cobranca.boletos.obterBoletos.BoletoBuscadoHateoas

Nome Tipo Descrição Tamanho Requerido
item bs2.pj.cobranca.boletos.obterBoletos.BoletoBuscadoResumido   - Não
links [ bs2.pj.cobranca.boletos.compartilhados.LinkHateoas ]   - Não

PaginaBoletoBuscadoHateoas

bs2.pj.cobranca.boletos.obterBoletos.PaginaBoletoBuscadoHateoas

Nome Tipo Descrição Tamanho Requerido
itens [ bs2.pj.cobranca.boletos.obterBoletos.BoletoBuscadoHateoas ]   - Não
inicio long   - Não
limite long   - Não
total long   - Não

CarteiraCodigoDescricao

bs2.pj.compartilhados.CarteiraCodigoDescricao

Nome Tipo Descrição Tamanho Requerido
descricao string   - Não
codigo integer   - Não

Sacado

bs2.pj.cobranca.boletos.compartilhados.Sacado

Nome Tipo Descrição Tamanho Requerido
email string   80 Não
telefone string   13 Não
tipo enum 1, 2 - Não
documento string   14 Não
nome string   150 Não
endereco bs2.pj.compartilhados.Endereco   - Não

SacadorAvalista

bs2.pj.cobranca.boletos.compartilhados.SacadorAvalista

Nome Tipo Descrição Tamanho Requerido
tipo enum 1, 2 - Não
documento string   14 Não
nome string   150 Não
endereco bs2.pj.compartilhados.Endereco   - Não

Mensagem

bs2.pj.cobranca.boletos.compartilhados.Mensagem

Nome Tipo Descrição Tamanho Requerido
linha1 string   80 Não
linha2 string   80 Não
linha3 string   80 Não
linha4 string   80 Não

Desconto

bs2.pj.cobranca.boletos.compartilhados.Desconto

Nome Tipo Descrição Tamanho Requerido
percentual double   - Não
valorFixo double   - Não
valorDiario double   - Não
limite dateTime   - Não

Multa

bs2.pj.cobranca.boletos.compartilhados.Multa

Nome Tipo Descrição Tamanho Requerido
valor double   - Não
data dateTime   - Não
juros double   - Não

NaturezaOperacao

bs2.pj.cobranca.boletos.compartilhados.NaturezaOperacao

Nome Tipo Descrição Tamanho Requerido
bs2.pj.cobranca.boletos.compartilhados.NaturezaOperacao integer   -  

BoletoBuscado

bs2.pj.cobranca.boletos.compartilhados.BoletoBuscado

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
nossoNumero long   - Não
seuNumero string   - Não
valor double   - Não
valorPago double   - Não
valorLiquidado double   - Não
carteira bs2.pj.compartilhados.CarteiraCodigoDescricao   - Não
movimento dateTime   - Não
vencimento dateTime   - Não
emissao dateTime   - Não
notificacaoPagamento dateTime   - Não
pagamento dateTime   - Não
cancelamento dateTime   - Não
canal string   - Não
sacado bs2.pj.cobranca.boletos.compartilhados.Sacado   - Não
sacadorAvalista bs2.pj.cobranca.boletos.compartilhados.SacadorAvalista   - Não
codigoBarras string   - Não
linhaDigitavel string   - Não
registrado boolean   - Não
mensagem bs2.pj.cobranca.boletos.compartilhados.Mensagem   - Não
desconto bs2.pj.cobranca.boletos.compartilhados.Desconto   - Não
multa bs2.pj.cobranca.boletos.compartilhados.Multa   - Não
status enum 1, 2, 3, 4 - Não
naturezaDaOperacaoDePagamento enum 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 99 - Não

BoletoBuscadoHateoas

bs2.pj.cobranca.boletos.compartilhados.BoletoBuscadoHateoas

Nome Tipo Descrição Tamanho Requerido
item bs2.pj.cobranca.boletos.compartilhados.BoletoBuscado   - Não
links [ bs2.pj.cobranca.boletos.compartilhados.LinkHateoas ]   - Não

Cliente

bs2.pj.cobranca.boletos.criarBoletoSimplificado.Cliente

Nome Tipo Descrição Tamanho Requerido
clienteId string (uuid)   - Não
telefone string   13 Não
email string   80 Não
tipo enum 1, 2 - Não
documento string   14 Não
nome string   150 Não
endereco bs2.pj.compartilhados.Endereco   - Não

CriarBoletoSimplificado

bs2.pj.cobranca.boletos.criarBoletoSimplificado.CriarBoletoSimplificado

Nome Tipo Descrição Tamanho Requerido
seuNumero string   - Sim
cliente bs2.pj.cobranca.boletos.criarBoletoSimplificado.Cliente   - Sim
sacadorAvalista bs2.pj.cobranca.boletos.compartilhados.SacadorAvalista   - Não
vencimento dateTime   - Sim
valor double   - Sim
canal string   - Não
multa bs2.pj.cobranca.boletos.compartilhados.Multa   - Não
desconto bs2.pj.cobranca.boletos.compartilhados.Desconto   - Não
mensagem bs2.pj.cobranca.boletos.compartilhados.Mensagem   - Não
aceite boolean   - Não
especie string   - Não

BoletoCriado

bs2.pj.cobranca.boletos.compartilhados.BoletoCriado

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
sacado bs2.pj.cobranca.boletos.compartilhados.Sacado   - Não
status enum 1, 2, 3, 4 - Não
nossoNumero long   - Não
codigoDeBarra string   - Não
linhaDigitavel string   - Não
seuNumero string   - Sim
clienteId string (uuid)   - Sim
sacadorAvalista bs2.pj.cobranca.boletos.compartilhados.SacadorAvalista   - Não
vencimento dateTime   - Sim
valor double   - Sim
canal string   - Não
multa bs2.pj.cobranca.boletos.compartilhados.Multa   - Não
desconto bs2.pj.cobranca.boletos.compartilhados.Desconto   - Não
mensagem bs2.pj.cobranca.boletos.compartilhados.Mensagem   - Não
aceite boolean   - Não
especie string   - Não

ResponsavelFinanceiro

bs2.pj.compartilhados.ResponsavelFinanceiro

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
documento string   - Não

TipoTarifa

bs2.pj.compartilhados.TipoTarifa

Nome Tipo Descrição Tamanho Requerido
bs2.pj.compartilhados.TipoTarifa integer   -  

Tarifa

bs2.pj.compartilhados.Tarifa

Nome Tipo Descrição Tamanho Requerido
tipo enum 1 - Não
valor double   - Não

TipoContaBancaria

bs2.pj.compartilhados.TipoContaBancaria

Nome Tipo Descrição Tamanho Requerido
bs2.pj.compartilhados.TipoContaBancaria integer   -  

ContaBancaria

bs2.pj.compartilhados.ContaBancaria

Nome Tipo Descrição Tamanho Requerido
codigoBanco integer   - Não
agencia integer   - Não
numero long   - Não
tipo enum 1, 2, 3 - Não

AlterarMerchant

bs2.pj.cobranca.merchants.alterarMerchant.AlterarMerchant

Nome Tipo Descrição Tamanho Requerido
cnpj string   - Não
nomeFantasia string   - Não
razaoSocial string   - Não
responsavelFinanceiro bs2.pj.compartilhados.ResponsavelFinanceiro   - Não
tarifa bs2.pj.compartilhados.Tarifa   - Não
contaBancaria bs2.pj.compartilhados.ContaBancaria   - Não

Desconto

bs2.pJ.apis.queries.cobranca.forIntegration.merchants.obterBoletoMerchantPorId.Desconto

Nome Tipo Descrição Tamanho Requerido
tipo integer   - Não
valor double   - Não
limite dateTime   - Não

TipoPessoa

bs2.pJ.apis.queries.compartilhados.TipoPessoa

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.apis.queries.compartilhados.TipoPessoa integer   -  

Endereco

bs2.pJ.apis.queries.compartilhados.Endereco

Nome Tipo Descrição Tamanho Requerido
cep string   - Não
estado string   - Não
cidade string   - Não
bairro string   - Não
logradouro string   - Não
numero string   - Não
complemento string   - Não

SacadoBoletoBuscado

bs2.pJ.apis.queries.compartilhados.boletos.SacadoBoletoBuscado

Nome Tipo Descrição Tamanho Requerido
telefone string   - Não
email string   - Não
tipo enum 1, 2 - Não
documento string   - Não
nome string   - Não
endereco bs2.pJ.apis.queries.compartilhados.Endereco   - Não

SacadorAvalistaBoletoBuscado

bs2.pJ.apis.queries.compartilhados.boletos.SacadorAvalistaBoletoBuscado

Nome Tipo Descrição Tamanho Requerido
tipo enum 1, 2 - Não
documento string   - Não
nome string   - Não
endereco bs2.pJ.apis.queries.compartilhados.Endereco   - Não

Mensagem

bs2.pJ.apis.queries.compartilhados.boletos.Mensagem

Nome Tipo Descrição Tamanho Requerido
linha1 string   - Não
linha2 string   - Não
linha3 string   - Não
linha4 string   - Não

StatusBoleto

bs2.pJ.apis.queries.cobranca.forIntegration.merchants.obterBoletoMerchantPorId.StatusBoleto

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.apis.queries.cobranca.forIntegration.merchants.obterBoletoMerchantPorId.StatusBoleto integer   -  

Boleto

bs2.pJ.apis.queries.cobranca.forIntegration.merchants.obterBoletoMerchantPorId.Boleto

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
nossoNumero long   - Não
seuNumero string   - Não
valor double   - Não
valorPago double   - Não
valorLiquidado double   - Não
merchantId string (uuid)   - Não
vencimentoEm dateTime   - Não
registradoEm dateTime   - Não
emitidoEm dateTime   - Não
pagoEm dateTime   - Não
liquidadoEm dateTime   - Não
canceladoEm dateTime   - Não
limitePagamento dateTime   - Não
desconto bs2.pJ.apis.queries.cobranca.forIntegration.merchants.obterBoletoMerchantPorId.Desconto   - Não
sacado bs2.pJ.apis.queries.compartilhados.boletos.SacadoBoletoBuscado   - Não
sacadorAvalista bs2.pJ.apis.queries.compartilhados.boletos.SacadorAvalistaBoletoBuscado   - Não
mensagem bs2.pJ.apis.queries.compartilhados.boletos.Mensagem   - Não
codigoBarras string   - Não
linhaDigitavel string   - Não
multa double   - Não
juros double   - Não
status enum 1, 2, 3, 4, 5 - Não

CriarMerchant

bs2.pj.cobranca.merchants.criarMerchant.CriarMerchant

Nome Tipo Descrição Tamanho Requerido
cnpj string   - Não
nomeFantasia string   - Não
razaoSocial string   - Não
responsavelFinanceiro bs2.pj.compartilhados.ResponsavelFinanceiro   - Não
tarifa bs2.pj.compartilhados.Tarifa   - Não
contaBancaria bs2.pj.compartilhados.ContaBancaria   - Não

TipoPessoa

bs2.pj.cobranca.merchants.criarBoletoMerchant.TipoPessoa

Nome Tipo Descrição Tamanho Requerido
bs2.pj.cobranca.merchants.criarBoletoMerchant.TipoPessoa integer   -  

Endereco

bs2.pj.cobranca.merchants.criarBoletoMerchant.Endereco

Nome Tipo Descrição Tamanho Requerido
logradouro string   - Não
numero string   - Não
complemento string   - Não
cep string   - Não
bairro string   - Não
cidade string   - Não
estado string   - Não

Sacado

bs2.pj.cobranca.merchants.criarBoletoMerchant.Sacado

Nome Tipo Descrição Tamanho Requerido
email string   - Não
telefone string   - Não
nome string   - Não
documento string   - Não
tipo enum 1, 2 - Não
endereco bs2.pj.cobranca.merchants.criarBoletoMerchant.Endereco   - Não

SacadorAvalista

bs2.pj.cobranca.merchants.criarBoletoMerchant.SacadorAvalista

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
documento string   - Não
tipo enum 1, 2 - Não
endereco bs2.pj.cobranca.merchants.criarBoletoMerchant.Endereco   - Não

TipoDesconto

bs2.pj.cobranca.merchants.criarBoletoMerchant.TipoDesconto

Nome Tipo Descrição Tamanho Requerido
bs2.pj.cobranca.merchants.criarBoletoMerchant.TipoDesconto integer   -  

Desconto

bs2.pj.cobranca.merchants.criarBoletoMerchant.Desconto

Nome Tipo Descrição Tamanho Requerido
tipo enum 1, 2 - Não
valor double   - Não
limite dateTime   - Não

Mensagem

bs2.pj.cobranca.merchants.criarBoletoMerchant.Mensagem

Nome Tipo Descrição Tamanho Requerido
linha1 string   - Não
linha2 string   - Não
linha3 string   - Não
linha4 string   - Não

BoletoMerchantParaCriar

bs2.pj.cobranca.merchants.criarBoletoMerchant.BoletoMerchantParaCriar

Nome Tipo Descrição Tamanho Requerido
seuNumero string   - Não
sacado bs2.pj.cobranca.merchants.criarBoletoMerchant.Sacado   - Não
sacadorAvalista bs2.pj.cobranca.merchants.criarBoletoMerchant.SacadorAvalista   - Não
vencimentoEm dateTime   - Não
valor double   - Não
merchantId string (uuid)   - Não
multa double   - Não
juros double   - Não
limitePagamento dateTime   - Não
desconto bs2.pj.cobranca.merchants.criarBoletoMerchant.Desconto   - Não
mensagem bs2.pj.cobranca.merchants.criarBoletoMerchant.Mensagem   - Não

BoletoMerchantCriado

bs2.pj.cobranca.merchants.criarBoletoMerchant.BoletoMerchantCriado

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
merchantId string (uuid)   - Não
sacado bs2.pj.cobranca.merchants.criarBoletoMerchant.Sacado   - Não
nossoNumero long   - Não
linhaDigitavel string   - Não
codigoDeBarra string   - Não

NotificarValidacaoConta

bs2.pj.cobranca.merchants.notificarValidacaoConta.NotificarValidacaoConta

Nome Tipo Descrição Tamanho Requerido
processadoComSucesso boolean   - Não
validacaoContaId string (uuid)   - Não

Precisa de mais informações?

Se você ainda tem dúvidas, entre em contato conosco, estamos prontos para atende-lo:

empresas@bs2.com