List payments

This endpoint aims to provide details of all charges paid by the client, including boletos and collection invoices.

Boleto

This is the conventional boleto (with digitable lines not starting with the digit 8). It is registered with the Interbank Payment Clearinghouse (CIP/Núclea) and can be paid at financial institutions and payment institutions authorized to operate by the Central Bank.

Collection Invoice

This type of charge is issued by utility companies (water, electricity, telephone, and gas bills) and public entities (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea) and, therefore, do not return the same information as a boleto.

Request

Request Endpoint

ENDPOINT

/account/ACCOUNT_KEY/payments

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta.	36
Field	Type	Description
---------------------	-------------	-----------------------------------
request_control_key	uuid4	Unique identification key for the client's request.
payment_key	uuid4	Unique payment identification key.
payment_type	enum	Payment type.
date_from	string	Start date. Format "YYYY-MM-DD".
date_to	string	End date. Format "YYYY-MM-DD".
page	string	Requested page number. 1 by default.
page_size	string	Requested page size in the query. 30 by default and maximum value.

Enumerators payment_type

Enumerator	Type	Description
bank_slip	string	Boleto
collection_slip	string	Collection invoice

Response

Success Response

STATUS

200

Response Body: Payment query

{
  "data": [
    {
        "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
        "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
        "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
        "payer_document_number":"00037025000160",
        "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
        "transaction_key":"4e80070a-a0bb-4be2-8178-55fbd73a3704",
        "transaction_revert_key":null,
        "paid_amount":1050.1,
        "payment_date":"2024-04-03",
        "payment_type":"bank_slip",
        "bank_slip": {
                "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
                "barcode":"00193967000009910000000003615574000000002417",
                "digitable_line":"00190000090361557400500000024174396700000991000",
                "payer_name":"COOPERATIVA TESTE",
                "payer_document_number":"00037025000160",
                "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
                "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
                "beneficiary_document_number":"52069937000117",
                "beneficiary_bank_ispb":"00000000",
                "guarantor_name":null,
                "guarantor_document_number":null,
                "expiration_date":"2024-03-29",
                "max_payment_data": "2026-03-29",
                "partial_payment_indicator":"allowed",
                "registered_payment_amount":9029.0,
                "nominal_amount":9910.0,
                "total_amount":10129.1,
                "rebate_amount":0.0,
                "discount_amount":0.0,
                "fine_amount":0.0,
                "interest_amount":219.1
            },
        "collection_slip":null,
        "payment_status":"executed"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Response Body Params

Field	Type	Description
payment_key *	uuid4	Unique payment identification key.
request_control_key *	uuid4	Unique identification key for the client's request.
payer_name *	string	Name of the effective payer.
payer_document_number *	string	Document number of the effective payer (CPF/CNPJ).
source_account_key *	uuid4	Key of the debited account.
transaction_key *	uuid4	Payment transaction key.
transaction_revert_key	uuid4	Payment reversal transaction key.
paid_amount *	number	Amount effectively paid.
payment_date *	string	Payment date.
payment_type *	enum	Payment type.
bank_slip	object	Boleto.
collection_slip	object	Collection invoice.
payment_status *	enum	Payment status.

Enumerators payment_type

Enumerator	Description
bank_slip	Boleto
collection_slip	Collection invoice

Enumerators payment_status

Enumerator	Description
pending_execution	Pending execution
executed	Executed
reverted	Reverted
rejected	Rejected
error	Error

Object bank_slip

Field	Type	Description
barcode *	string	Barcode.
digitable_line *	string	Digitable line.
payer_name *	string	Payer's name.
payer_document_number *	string	Payer's document number (CPF/CNPJ).
beneficiary_name *	string	Beneficiary's name.
beneficiary_trading_name	string	Beneficiary's trade name.
beneficiary_document_number *	string	Beneficiary's document number (CPF/CNPJ).
beneficiary_bank_ispb *	string	ISPB code of the beneficiary's bank.
guarantor_name	string	Name of the guarantor.
guarantor_document_number	string	Guarantor's document number (CPF/CNPJ).
expiration_date *	string	Due date.
max_payment_date *	string	Maximum payment date.
partial_payment_indicator *	enum	Partial payment indicator.
registered_payment_amount	string	Total registered payment amount.
nominal_amount *	number	Original amount.
total_amount *	number	Total amount.
rebate_amount *	number	Rebate amount.
discount_amount *	number	Discount amount.
fine_amount *	number	Fine amount.
interest_amount *	number	Interest amount.

Enumerators partial_payment_indicator

Enumerator	Description
allowed	Allowed
not_allowed	Not allowed

Object collection_slip

Field	Type	Description
barcode *	string	Barcode.
digitable_line *	string	Digitable line.
collection_name *	string	Name of the agreement.
collection_document_number *	string	Document number of the agreement (CPF/CNPJ).
expiration_date *	string	Due date.
total_amount *	number	Total amount.

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Description in portuguese",
    "code": "Código"
}

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
400	BIP000026	Bad Request	Invalid payment date format. The correct format is YYYY-MM-DD.	Formato de data de pagamento inválido. O formato correto é YYYY-MM-DD.
400	BIP000027	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
400	BIP000047	Bad Request	Invalid payment type.	Tipo de pagamento inválido.