Listar Boletos PJBank

Descrição

Retorna a lista de boletos bancários emitidos via PJBank para a filial autenticada. Permite filtragem por período, status de pagamento e página.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
dateStart	date-time	Sim	Data inicial para filtragem dos boletos. Utilize no formato ISO 8601.
dateEnd	date-time	Sim	Data final para filtragem dos boletos. Utilize no formato ISO 8601.
paid	boolean	Sim	Indica se devem ser retornados boletos pagos (`true`) ou não pagos (`false`).
page	int32	Sim	Número da página a ser consultada.

📤 Estrutura da Resposta

A resposta retorna a lista de boletos PJBank encontrados com base nos filtros informados.

Campo	Tipo	Descrição
valor	string	Valor atual do boleto.
valor_original	string	Valor original do boleto no momento da emissão.
valor_pago	string	Valor efetivamente pago pelo pagador.
valor_liquido	string	Valor líquido recebido após descontos, tarifas ou taxas aplicáveis.
valor_tarifa	string	Valor da tarifa cobrada pela operação do boleto.
nosso_numero	string	Número de identificação do boleto no banco.
nosso_numero_original	string	Número original de identificação do boleto, quando houver alteração.
id_unico	string	Identificador único do boleto no PJBank.
id_unico_original	string	Identificador único original do boleto, quando houver alteração.
pedido_numero	string	Número do pedido ou referência associada ao boleto.
banco_numero	string	Número do banco relacionado ao boleto.
token_facilitador	string	Token do facilitador responsável pela emissão ou processamento do boleto.
data_vencimento	string	Data de vencimento do boleto.
data_pagamento	string	Data em que o boleto foi pago.
data_credito	string	Data em que o valor foi creditado.
pagador	string	Nome ou identificação do pagador do boleto.
registro_sistema_bancario	string	Indica o status ou registro do boleto no sistema bancário.
data_registro_sistema_bancario	string	Data em que o boleto foi registrado no sistema bancário.
linkGrupo	string	Link relacionado ao grupo ou conjunto de boletos.
link	string	Link direto para acesso ao boleto.
link_info	string	Link com informações adicionais sobre o boleto.
qrcode	string	Código QR Code associado ao boleto, quando disponível.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200

application/json

Success

Body

Exemplo

[
    {
        "valor": "string",
        "valor_original": "string",
        "valor_pago": "string",
        "valor_liquido": "string",
        "valor_tarifa": "string",
        "nosso_numero": "string",
        "nosso_numero_original": "string",
        "id_unico": "string",
        "id_unico_original": "string",
        "pedido_numero": "string",
        "banco_numero": "string",
        "token_facilitador": "string",
        "data_vencimento": "string",
        "data_pagamento": "string",
        "data_credito": "string",
        "pagador": "string",
        "registro_sistema_bancario": "string",
        "data_registro_sistema_bancario": "string",
        "linkGrupo": "string",
        "link": "string",
        "link_info": "string",
        "qrcode": "string"
    }
]

🟠400

List PJBank boletos (bank slips) for the authenticated branch.

Listar Boletos PJBank#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#