列出清算记录

信息

在我们的系统中，清算记录描述了将已支付票据的金额转移至应收款账户的过程。简而言之，每当 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_group/ BANK_SLIP_SETTLEMENT_GROUP_KEY/bank_slip_settlements

MÉTODO

GET

Path parameters

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

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

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

Objeto bank_slip_settlement

字段	类型	描述	字符数
`settlement_key`	uuidv4	清算记录唯一标识键	36
`account_key`	uuidv4	账户唯一标识键	36
`amount`	float	已清算金额	-
`bank_slip_key`	uuidv4	票据唯一标识键，uuid v4 格式
`barcode`	string	票据条形码

Objeto pagination

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

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	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.

Request​

Path parameters​

Response​

Response Body Params​

Objeto bank_slip_settlement​

Objeto pagination​

Error Response​