Skip to main content
Consulta todos os boletos bancários registrados de uma conta específica.
Through this endpoint, the partner can list the bills registered with BMP-274, this process is exclusive to the integrator.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

DocumentoFederal
string

Número do CPF ou CNPJ do correntista.

Observação:

  • Quando o 'número da conta bancária seguido do dígito verificador' (contaPgto) estiver preenchido, o 'número do CPF ou CNPJ do correntista' (documentoFederal) não deve ser informado.
Conta.Banco
string

Número do banco.

Observação:

  • São aceitos somentes os bancos números 274 ou 531.
Conta.Agencia
string

Número da agência bancária.

Conta.ContaPgto
string

Número da conta bancária seguido do dígito verificador.

Observação:

  • Quando o 'número do CPF ou CNPJ do correntista' (documentoFederal) estiver preenchido, o 'número da conta bancária seguido do dígito verificador' (contaPgto) não deve ser informado.
Filtro.CarteiraInicial
integer<int32>

Número da carteira inicial da busca.

Observação:

  • O 'número da carteira inicial' (carteiraInicial) não pode ser maior que o 'número da carteira final' (carteiraFinal), quando este for informado.
Filtro.CarteiraFinal
integer<int32>

Número da carteira final da busca.

Observação:

  • O 'número da carteira final' (carteiraFinal) não pode ser menor que o 'número da carteira inicial' (carteiraInicial), quando este for informado.
Filtro.DtRegistroInicial
string<date-time>

Data de registro inicial da busca.

Observação:

  • A 'data de registro inicial' (dtRegistroInicial) não pode ser posterior à 'data de registro final' (dtRegistroFinal), quando esta for informada.
Filtro.DtRegistroFinal
string<date-time>

Data de registro final da busca.

Observações:

  • A 'data de registro final' (dtRegistroFinal) não pode ser anterior à 'data de registro inicial' (dtRegistroInicial), quando esta for informada.
  • O intervalo de dias entre a 'data de registro inicial' (dtRegistroInicial) e a 'data de registro final' (dtRegistroFinal) não pode ser superior a 31 dias.
Filtro.DtVenctoInicial
string<date-time>

Data de vencimento inicial da busca.

Observação:

  • A 'data de vencimento inicial' (dtVenctoInicial) não pode ser posterior à 'data de vencimento final' (dtVenctoFinal), quando esta for informada.
Filtro.DtVenctoFinal
string<date-time>

Data de vencimento final da busca.

Observações:

  • A 'data de vencimento final' (dtVenctoFinal) não pode ser anterior à 'data de vencimento inicial' (dtVenctoInicial), quando esta for informada.
  • O intervalo de dias entre a 'data de vencimento inicial' (dtVenctoInicial) e a 'data de vencimento final' (dtVenctoFinal) não pode ser superior a 31 dias.
Filtro.SituacaoBoleto
enum<integer>

Situacao do boleto.*

Valores: 1 - Pendente Registro 2 - Registrado 3 - Erro Registro 4 - Pago 5 - Baixado Cedente 6 - Baixado Data Limite Pagto 7 - Pendente Baixa Cedente 8 - Pendente Baixa Protesto 9 - Protestado 10 - Pago Em Cartório

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
Filtro.Page
integer<int32>

Número da página.

Filtro.PageSize
integer<int32>

Tamanho da página. Itens por página.

Response

Success

sucesso
boolean
mensagem
string | null
dtConsulta
string<date-time> | null
read-only
documentoFederal
string | null
conta
object | null
filtro
object | null
cedentes
object[] | null