列出清算组

信息

在我们的系统中，清算组是协调交易与已清算票据的一种方式。该流程（清算）描述了将已支付票据的金额转移至应收款账户的过程。简而言之，每当 QI 收到票据已被其他银行支付（或对于已抗议的票据，由公证处支付）的信息时，就会为该特定票据创建一条清算记录。随后，会创建清算组，这些清算组表示按类型分组的清算批次。

此后，会为该清算组执行向客户账户的付款交易。该交易的 transaction_key 随后将保存用于对账，通过此方式您可以查看在某次特定交易中已清算的所有票据。例如，若您有五张各 R$ 5.00 的票据，其中一张通过公证处支付，一张通过 QR Code PIX 支付，另外三张由其他银行通过可输入行或条形码支付，则会为这些票据创建五条清算记录。随后，这些清算记录将被分为三个清算组：一个 R$ 15.00 的清算组包含三张通过可输入行或条形码支付的票据（对其执行一笔交易）；一个 R$ 5.00 的清算组包含通过 QR Code PIX 支付的票据；最后一个 R$ 5.00 的清算组包含通过公证处支付的票据。

清算组列表将返回符合请求中发送的查询参数的所有账户清算组。

Request

ENDPOINT

/account/ACCOUNT_KEY/bank_slip_settlement_groups

MÉTODO

GET

Path parameters

字段	类型	描述	字符数
`account_key`	uuidv4	账户唯一标识键	36

Query parameters

字段	类型	描述	字符数
`bank_slip_settlement_group_key`	uuidv4	清算组唯一标识键，uuid v4 格式	36
`transaction_key`	uuidv4	清算组交易唯一标识键，uuid v4 格式	36
`bank_slip_settlement_group_status`	string	清算组状态	Enumeradores bank_slip_settlement_group_status
`date_from`	string	起始日期，格式"YYYY-MM-DD"
`date_to`	string	结束日期，格式"YYYY-MM-DD"
`page`	integer	页码	-
`page_size`	integer	每页大小	-

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

字段	类型	描述	字符数
`data`	object array	票据	Objeto bank_slip_settlement_group
`pagination`	object	分页信息	Objeto pagination

Objeto bank_slip_settlement_group

字段	类型	描述	字符数
`bank_slip_settlement_group_key`	uuidv4	清算组唯一标识键，uuid v4 格式	36
`account_key`	uuidv4	账户唯一标识键	36
`transaction_key`	uuidv4	清算组交易唯一标识键，uuid v4 格式	36
`amount`	float	已清算总金额	-
`bank_slip_settlement_group_type`	string	清算组类型	Enumeradores bank_slip_settlement_group_type
`bank_slip_settlement_group_status`	string	清算组状态	Enumeradores bank_slip_settlement_group_status
`bank_slip_settlement_quantity`	integer	清算组中的清算数量	-

Objeto pagination

字段	类型	描述	字符数
`current_page`	integer	当前页码	-
`rows_per_page`	integer	每页记录数	-

Enumeradores bank_slip_settlement_group_type

枚举值	描述
siloc	用于票据支付（票据金额小于 R$ 250.000）
qr_code	用于通过 QR Code 支付的票据
str	用于大额票据支付（票据金额大于 R$ 250.000）
notary_office	用于通过公证处支付的票据

Enumeradores bank_slip_settlement_group_status

枚举值	描述
pending	清算组已创建，但交易尚未执行
settled	清算组已创建，且交易已执行

Error Response

STATUS

4xx

Response Body: Error

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

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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.

Request​

Path parameters​

Query parameters​

Response​

Response Body Params​

Objeto bank_slip_settlement_group​

Objeto pagination​

Enumeradores bank_slip_settlement_group_type​

Enumeradores bank_slip_settlement_group_status​

Error Response​