Listar liquidações

Informação

Em nosso sistema, as liquidações descrevem 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 aos quais elas sempre estarão atreladas, 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 liquidações retornará todas as liquidações do grupo de liquidação enviado na request.

Request

ENDPOINT

/account/ACCOUNT_KEY/bank_slip_settlement_group/ BANK_SLIP_SETTLEMENT_GROUP_KEY/bank_slip_settlements

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta	36
bank_slip_settlement_group_key	uuidv4	Chave única de identificação do grupo de liquidação

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

Campo	Tipo	Descrição	Caracteres
data	object array	Boletos	Objeto bank_slip_settlement
pagination	object	Informações de paginação	Objeto pagination

Objeto bank_slip_settlement

Campo	Tipo	Descrição	Caracteres
settlement_key	uuidv4	Chave única de identificação da liquidação	36
account_key	uuidv4	Chave única de identificação da conta	36
amount	float	Valor liquidado	-
bank_slip_key	uuidv4	Chave única de identificação do boleto no formato uuid v4
barcode	string	Código de barras do boleto

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page	integer	Página atual	-
rows_per_page	integer	Itens por página	-

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	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.
404	BKS000093	Bad Request	Settlement group not found for the given key.	Grupo de liquidação não encontrado para a chave fornecida.