List PJBank Bank Slips

Description

Returns the list of bank slips issued via PJBank for the authenticated branch. Allows filtering by period, payment status, and page.

🔑 Query Parameters

Parameter	Type	Required	Description
`dateStart`	`string (date-time)`	Yes	Initial date for filtering bank slips. Use ISO 8601 format.
`dateEnd`	`string (date-time)`	Yes	Final date for filtering bank slips. Use ISO 8601 format.
`paid`	`boolean`	Yes	Indicates whether paid bank slips (`true`) or unpaid bank slips (`false`) should be returned.
`page`	`int32`	Yes	Page number to be queried.

📤 Response Structure

The response returns the list of PJBank bank slips found based on the provided filters.

Field	Type	Description
`valor`	string	Current value of the bank slip.
`valor_original`	string	Original value of the bank slip at the time of issuance.
`valor_pago`	string	Amount effectively paid by the payer.
`valor_liquido`	string	Net amount received after applicable discounts, fees, or charges.
`valor_tarifa`	string	Fee amount charged for the bank slip operation.
`nosso_numero`	string	Bank slip identification number in the bank.
`nosso_numero_original`	string	Original bank slip identification number, when changed.
`id_unico`	string	Unique identifier of the bank slip in PJBank.
`id_unico_original`	string	Original unique identifier of the bank slip, when changed.
`pedido_numero`	string	Order number or reference associated with the bank slip.
`banco_numero`	string	Bank number related to the bank slip.
`token_facilitador`	string	Token of the facilitator responsible for issuing or processing the bank slip.
`data_vencimento`	string	Due date of the bank slip.
`data_pagamento`	string	Date on which the bank slip was paid.
`data_credito`	string	Date on which the amount was credited.
`pagador`	string	Name or identification of the bank slip payer.
`registro_sistema_bancario`	string	Indicates the status or registration of the bank slip in the banking system.
`data_registro_sistema_bancario`	string	Date on which the bank slip was registered in the banking system.
`linkGrupo`	string	Link related to the group or set of bank slips.
`link`	string	Direct link to access the bank slip.
`link_info`	string	Link with additional information about the bank slip.
`qrcode`	string	QR Code associated with the bank slip, when available.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Success

Body

Example

[
    {
        "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.

List PJBank Bank Slips#

Description#

🔑 Query Parameters#