API docs by Redocly

Boleto Bimer

Download OpenAPI specification:

A API de Boletos disponibilizada pelo Bimer possui um conjunto de Endpoints que se destinam a padronizar a geração de boletos, assim como padronizar e servir de fachada para acessar funcionalidades de integração com bancos para funcionalidades que eles provenham no que tange à emissão de boletos.

Desenvolvida pela equipe Bimer API. Contato: bimerapi@alterdata.com.br.

Autenticação

Obter token para utilização no serviço

Retorna o token que deve ser utilizado nos demais Endpoints (fora do path "/oauth"). O token dura vinte e quatro horas, período após o qual expira, sendo necessário obter outro através dessa mesma URL.

Nota: o token expira após 1440 minutos (24 horas).

query Parameters
info
required
string
Example: info=TOKEN

O token do Passaporte para o usuário que vai se autenticar ao serviço. Maiores detalhes de como obter esse token devem ser vistos com o setor responsável pelo Passaporte.

idAssinante
required
integer
Example: idAssinante=12345

O identificador do assinante junto ao Passaporte.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Response samples

Content type
application/json
{
  • "tokenAcesso": "Token",
  • "tipoToken": "Bearer"
}

Obtém a URL do Passaporte utilizado por esse serviço

Facilitador (não obrigatório para a autenticação) que retorna a URL do ambiente do Passaporte utilizado pelo Boleto. Importante notar que a URL irá variar conforme o ambiente da API (Homologação, Produção).

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Obtém os assinantes a partir de um Token do Passaporte

Facilitador (não obrigatório para a autenticação) que retorna os assinantes, dado um token do Passaporte. Utilizado para quando não souber qual o assinante deverá ser utilizado para autenticar no servido, podendo listar para possíveis escolhas.

query Parameters
info
required
string
Example: info=TOKEN

O token do Passaporte para o usuário que vai se autenticar ao serviço. Maiores detalhes de como obter esse token devem ser vistos com o setor responsável pelo Passaporte.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Obtém o token do Passaporte a partir de um token do serviço

Facilitador (não obrigatório para a autenticação) que retorna o token do Passaporte a partir de um token da Aplicação, caso deseje se recuperar essa informação.

query Parameters
token
required
string
Example: token=TOKEN

O token gerado pela API de Boletos.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Response samples

Content type
application/json
{
  • "tokenAcesso": "Token",
  • "tipoToken": "Bearer"
}

Boletos

Geração de boletos em PDF

Gera um ou mais boletos em PDF, utilizando um layout padrão com o logotipo do banco.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Request Body schema: application/json
Array
object (Pessoa)
object (Pessoa)
object (Instrucoes)
object (Banco)
object (Valores)
object (Percentuais)
object (Datas)
numeroDocumento
string

O número do documento equivalente ao documento.

nossoNumero
string

O "nosso número" do boleto.

moeda
string

A moeda na qual o boleto deverá ser pago.

aceite
boolean

Se é necessário aceite do boleto pelo pagador.

especie
number

A espécie do boleto.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Geração de boletos em imagem

Gera um ou mais boletos em imagem (PNG), utilizando um layout padrão com o logotipo do banco.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Request Body schema: application/json
Array
object (Pessoa)
object (Pessoa)
object (Instrucoes)
object (Banco)
object (Valores)
object (Percentuais)
object (Datas)
numeroDocumento
string

O número do documento equivalente ao documento.

nossoNumero
string

O "nosso número" do boleto.

moeda
string

A moeda na qual o boleto deverá ser pago.

aceite
boolean

Se é necessário aceite do boleto pelo pagador.

especie
number

A espécie do boleto.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Geração de boletos em PDF específico para a Alterdata

Gera um ou mais boletos em PDF, utilizando o layout da empresa com o logotipo do banco.

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que irá emitir os boletos (sem máscara).

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Request Body schema: application/json
Array
object (Pessoa)
object (Valores)
object (Datas)
numeroDocumento
string

O número do documento equivalente ao documento.

nossoNumero
string

O "nosso número" do boleto.

identificadorTitulo
string

O ID do título no Bimer.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Geração de boletos em PDF específico para a Alterdata

Gera um ou mais boletos em imagem (PNG), utilizando o layout da empresa com o logotipo do banco.

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que irá emitir os boletos (sem máscara).

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Request Body schema: application/json
Array
object (Pessoa)
object (Valores)
object (Datas)
numeroDocumento
string

O número do documento equivalente ao documento.

nossoNumero
string

O "nosso número" do boleto.

identificadorTitulo
string

O ID do título no Bimer.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Cobrança - específico para a Alterdata

Registrar cobrança

Registra uma cobrança junto ao banco, utilizando os dados da empresa informada através do CNPJ, tornando um boleto apto para ser impresso.

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que irá registrar a cobrança (sem máscara).

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Request Body schema: application/json
object (Pessoa)
object (Valores)
object (Datas)
numeroDocumento
string

O número do documento equivalente ao documento.

nossoNumero
string

O "nosso número" do boleto.

identificadorTitulo
string

O ID do título no Bimer.

Responses

Request samples

Content type
application/json
Example
{
  • "sacado": {
    },
  • "valores": {
    },
  • "datas": {
    },
  • "numeroDocumento": "12345",
  • "nossoNumero": "1234567890",
  • "identificadorTitulo": "0010000001"
}

Response samples

Content type
application/json
{
  • "conteudoBanco": { }
}

Obter lista de boletos com recálculo de valores

Obtém a lista de boletos e seus dados principais, por empresa e cliente.

Nota: no caso do banco Itaú, a API não detém a capacidade de obter o PDF do boleto com os valores recalculados. Para maiores informações, entre em contato com a equipe Bimer API.

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que emitiu o boleto (sem máscara).

cpfCnpjDoCliente
required
string

O CPF/CNPJ do cliente (sacado) do boleto (sem máscara).

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obter boleto com recálculo de valores

Obtém um boleto e seus dados principais, por empresa, cliente e nosso número.

Nota: no caso do banco Itaú, a API não detém a capacidade de obter o PDF do boleto com os valores recalculados. Para maiores informações, entre em contato com a equipe Bimer API.

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que emitiu o boleto (sem máscara).

cpfCnpjDoCliente
required
string

O CPF/CNPJ do cliente (sacado) do boleto (sem máscara).

nossoNumero
required
string

O "Nosso Número" do boletio junto ao banco.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer TOKEN

e.g. Bearer TOKEN

Responses

Response samples

Content type
application/json
{
  • "nossoNumero": "12345",
  • "valor": 100,
  • "vencimento": "2018",
  • "linkBoleto": "ABCDEF"
}

Informações Gerais

Informações do Serviço

Obtém o status geral do serviço.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Responses

Response samples

Content type
application/json
{
  • "alive": true,
  • "versao": "1.0.0"
}

Configurações de boleto por empresa

Obtém as configurações de boleto por empresa (para a Alterdata).

Nota: esse endpoint requer permissões especiais

path Parameters
cnpjDaEmpresa
required
string

O CNPJ da empresa que irá emitir os boletos (sem máscara).

Configurações de registro de cobrança

Obtém as configurações de registro de cobrança (para a Alterdata).

Nota: esse endpoint requer permissões especiais