跳到主要内容

查询临时 Pix 限额申请

列出请求方自己的临时 Pix 限额申请。除 Webhook 之外，这里也是跟踪人工审核结果的方式。

请求​

ENDPOINT
/baas/pix/exceptional_pix_request
方法
GET

如需查询某一个申请，将其标识键附加到 URL 上： /baas/pix/exceptional_pix_request/PIX_REQUEST_KEY。响应格式相同，列表中只包含被查询的申请。

本操作没有时间限制。

Path Params​

字段类型描述字符数
pix_request_keyuuidv4限额申请的唯一标识键。可选 —— 不提供时列出全部申请。36

Query Params​

字段类型描述字符数
account_keyuuidv4按该申请所适用的账户筛选。36
statusstring按状态筛选。支持以逗号分隔的多个值。—
pageinteger需要返回的页码。—
page_sizeinteger每页的记录数。最大值与默认值均为 30。—
信息

查询始终仅限于请求方自己的申请 —— 即使知道 pix_request_key，也无法查询其他合作伙伴的申请。

响应​

Response Body: 200 OK
{
  "data": [
    {
      "pix_request_key": "9c3b7d21-8f4a-4c2b-9e1d-7a6b5c4d3e2f",
      "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
      "total_amount": 1200000.00,
      "request_reason": "folha de pagamento do cliente Alfa Ltda",
      "status": "approved",
      "message": "Request approved and available for use today until 20:00."
    }
  ],
  "page": 1,
  "page_size": 30,
  "has_next_page": false,
  "requires_manual_approval": false
}

Response Body Params​

字段类型描述
dataarray临时 Pix 限额申请列表。
pageinteger返回的页码。
page_sizeinteger每页的记录数。
has_next_pageboolean是否存在下一页。
requires_manual_approvalboolean请求方的新申请是否处于强制人工审核。参见额度使用不足。

data 中每项的字段：

字段类型描述
pix_request_keyuuidv4临时 Pix 限额申请的唯一标识键。
account_keyuuidv4该申请所适用的账户。
total_amountnumber当日申报的总额度。
request_reasonstring请求中填写的原因。
statusenumerator申请状态。参见 Temporary Pix Request Status。
messagestring状态的描述文本，为英文。
rejected_reasonstring拒绝原因，若已填写。可选 —— 即使申请被拒绝也可能不返回该字段。

错误​

本操作没有专属错误 —— 不属于该请求方的 pix_request_key 只会返回空记录。其他操作的错误列于 Temporary Pix 错误表。