Listar grupos de liquidação
Em nosso sistema, os grupos de liquidação são uma forma de conciliar as transações com os boletos liquidados. Esse processo (liquidação) descreve a transferência do valor de um boleto pago para a conta que deve receber esse pagamento. Resumidamente, sempre que a QI recebe a informação de que um boleto foi pago por outro banco ou, no caso de boletos protestados, pelo cartório, é criada uma liquidação para esse boleto específico. Posteriormente, são criados os grupos de liquidação, que representam lotes de liquidações agrupadas por tipo.
Em um momento posterior, é realizada a transação de pagamento desse grupo de liquidação para a conta do cliente. A transaction_key dessa transação é então salva para fins de conciliação, dessa foma você pode ver todos os boletos que foram liquidados em uma determinada transação. Por exemplo, se você tiver cinco boletos de R$ 5,00 cada, sendo que um foi pago via cartório, um foi pago via QR Code PIX e os outros três foram pagos utilizando a linha digitável ou código de barras por outro banco, serão criadas cinco liquidações referentes a esses boletos. Em seguida, essas liquidações serão agrupadas em três grupos de liquidação: um de R$ 15,00 com os três boletos pagos utilizando a linha digitável ou código de barras, para os quais será realizada uma única transação, outro de R$ 5,00 para o boleto pago via QR Code PIX e o último também de R$ 5,00 com o boleto pago via cartório.
A listagem de grupos de liquidação retornará todos os grupos de liquidação da conta que se enquadrarem nos query parameters enviados na request.
Request
Path parameters
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_key | uuidv4 | Chave única de identificação da conta | 36 |
Query parameters
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
bank_slip_settlement_group_key | uuidv4 | Chave única de identificação do grupo de liquidação | 36 |
transaction_key | uuidv4 | Chave única de identificação da transação do grupo de liquidação | 36 |
bank_slip_settlement_group_status | string | Status do grupo de liquidação | Enumeradores bank_slip_settlement_group_status |
page | integer | Número da página | - |
page_size | integer | Tamanho da página | - |
Response
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
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
data | object array | Boletos | Objeto bank_slip_settlement_group |
pagination | object | Informações de paginação | Objeto pagination |
Objeto bank_slip_settlement_group
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
bank_slip_settlement_group_key | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
account_key | uuidv4 | Chave única de identificação da conta | 36 |
transaction_key | uuidv4 | Chave única de identificação da transação do grupo de liquidação | 36 |
amount | float | Valor total liquidado | - |
bank_slip_settlement_group_type | string | Tipo do grupo de liquidação | Enumeradores bank_slip_settlement_group_type |
bank_slip_settlement_group_status | string | Status do grupo de liquidação | Enumeradores bank_slip_settlement_group_status |
bank_slip_settlement_quantity | integer | Quantidade de liquidações do grupo | - |
Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
current_page | integer | Página atual | - |
rows_per_page | integer | Itens por página | - |
Enumeradores bank_slip_settlement_group_type
| Enumerador | Descrição |
|---|---|
| siloc | para pagamento de títulos (valor do título menor que R$ 250.000) |
| qr_code | para pagamento de títulos realizados via QR Code |
| str | para pagamento de títulos VR (valor do título maior que R$ 250.000) |
| notary_office | para pagamento de títulos realizados via cartório |
Enumeradores bank_slip_settlement_group_status
| Enumerador | Descrição |
|---|---|
| pending | grupo de liquidação criado mas a transação não foi realizada |
| settled | grupo de liquidação criado e transação realizada |
Error Response
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTPstatus | Código QIcode | Títulotitle | Descrição (eng)description | Descrição (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. |