List Settlements

Information

In our system, settlements describe the transfer of value from a paid bank slip to the account that should receive that payment. In summary, whenever QI receives information that a bank slip has been paid by another bank or, in the case of protested bank slips, by the notary office, a settlement is created for that specific bank slip. Subsequently, settlement groups are created to which they will always be linked, representing batches of settlements grouped by type.

At a later moment, a payment transaction is performed for this settlement group to the client's account. The transaction_key of this transaction is then saved for reconciliation purposes, so you can see all bank slips that were settled in a specific transaction. For example, if you have five bank slips of R$ 5.00 each, where one was paid via notary office, one was paid via PIX QR Code, and the other three were paid using the barcode or typed line by another bank, five settlements will be created for these bank slips. Then, these settlements will be grouped into three settlement groups: one of R$ 15.00 with the three bank slips paid using the barcode or typed line, for which a single transaction will be performed, another of R$ 5.00 for the bank slip paid via PIX QR Code, and the last one also of R$ 5.00 with the bank slip paid via notary office.

The settlement listing will return all settlements from the settlement group sent in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/bank_slip_settlement_group/ BANK_SLIP_SETTLEMENT_GROUP_KEY/bank_slip_settlements

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key	36
bank_slip_settlement_group_key	uuidv4	Unique settlement group identification key

Response

STATUS

200

Response Body

{
    "data": [
        {
            "settlement_key": "388eac3a-4138-421c-86af-f6fe3d1a9419",
            "amount": 4800.0,
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "bank_slip_key": "d39e243b-8532-4006-9ffd-17607d5d1620",
            "barcode": "32991981000275000002269450000000043200779790"
        },
        {
            "settlement_key": "c3d7c62e-73fa-473f-b5a2-82e9b8a7f9bb",
            "amount": 1.0,
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "bank_slip_key": "3088ffdd-dec0-4fa3-8643-995d6809a2e6",
            "barcode": "32999980300000001000001370000000000100828480"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}

Response Body Params

Field	Type	Description	Characters
data	object array	Bank slips	bank_slip_settlement object
pagination	object	Pagination information	pagination object

bank_slip_settlement object

Field	Type	Description	Characters
settlement_key	uuidv4	Unique settlement identification key	36
account_key	uuidv4	Unique account identification key	36
amount	float	Settled amount	-
bank_slip_key	uuidv4	Unique bank slip identification key in uuid v4 format
barcode	string	Bank slip barcode

pagination object

Field	Type	Description	Characters
current_page	integer	Current page	-
rows_per_page	integer	Items per page	-

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (pt-br) translation
400	QIT000001	Bad Request	Schema Error	Schema Inválido
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BKS000012	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.
404	BKS000093	Bad Request	Settlement group not found for the given key.	Grupo de liquidação não encontrado para a chave fornecida.