List settlement groups

Information

In our system, settlement groups are a way to reconcile transactions with settled bank slips. This process (settlement) describes the transfer of a paid bank slip amount to the account that should receive this 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, which represent batches of settlements grouped by type.

At a later moment, the payment transaction for this settlement group is made to the client's account. The transaction_key of this transaction is then saved for reconciliation purposes, so you can see all the bank slips that were settled in a specific transaction. For example, if you have five R$ 5.00 bank slips each, where one was paid via notary office, one was paid via QR Code PIX and the other three were paid using the typed line or barcode 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 typed line or barcode, for which a single transaction will be made, another of R$ 5.00 for the bank slip paid via QR Code PIX and the last one also of R$ 5.00 with the bank slip paid via notary office.

The settlement groups listing will return all settlement groups of the account that fit the query parameters sent in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/bank_slip_settlement_groups

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key	36

Query parameters

Field	Type	Description	Characters
bank_slip_settlement_group_key	uuidv4	Unique settlement group identification key	36
transaction_key	uuidv4	Unique settlement group transaction identification key	36
bank_slip_settlement_group_status	string	Settlement group status	Enumerators bank_slip_settlement_group_status
date_from	string	Start date. Format "YYYY-MM-DD".
date_to	string	End date. Format "YYYY-MM-DD".
page	integer	Page number	-
page_size	integer	Page size	-

Response

STATUS

200

Response Body

{
    "data": [
        {
            "bank_slip_settlement_group_key": "5ba0b0cf-ac4a-4c91-819d-d6c46d70e3ab",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "6704d927-9e0d-411d-8c44-c377c0c56637",
            "amount": 1069.24,
            "bank_slip_settlement_group_type": "notary_office",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 1
        },
        {
            "bank_slip_settlement_group_key": "feda6069-c0cf-4148-b881-a475737330ab",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "00d557de-78ca-4871-b254-2852499660e2",
            "amount": 2400.0,
            "bank_slip_settlement_group_type": "siloc",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 303
        },
        {
            "bank_slip_settlement_group_key": "5493030c-ba1c-44de-9e85-5aaee0afe46d",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "b42c4d0a-8060-41d7-bd00-17889cc76485",
            "amount": 250.0,
            "bank_slip_settlement_group_type": "siloc",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 50
        },
        {
            "bank_slip_settlement_group_key": "f33c087d-cbae-47a9-bd5a-e6a8ecc04ed2",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "6ee57aea-b589-4dff-9555-200c34380154",
            "amount": 4024800.0,
            "bank_slip_settlement_group_type": "str",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 16
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}

Response Body Params

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

Object bank_slip_settlement_group

Field	Type	Description	Characters
bank_slip_settlement_group_key	uuidv4	Unique bank slip identification key in uuid v4 format	36
account_key	uuidv4	Unique account identification key	36
transaction_key	uuidv4	Unique settlement group transaction identification key	36
amount	float	Total settled amount	-
bank_slip_settlement_group_type	string	Settlement group type	Enumerators bank_slip_settlement_group_type
bank_slip_settlement_group_status	string	Settlement group status	Enumerators bank_slip_settlement_group_status
bank_slip_settlement_quantity	integer	Number of settlements in the group	-

Object pagination

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

Enumerators bank_slip_settlement_group_type

Enumerator	Description
siloc	for payment of securities (security value less than R$ 250,000)
qr_code	for payment of securities made via QR Code
str	for payment of VR securities (security value greater than R$ 250,000)
notary_office	for payment of securities made via notary office

Enumerators bank_slip_settlement_group_status

Enumerator	Description
pending	settlement group created but transaction not performed
settled	settlement group created and transaction performed

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	BKS000095	Bad Request	Invalid bank slip settlement group status.	Status de grupo de liquidação de boleto inválido.