跳到主要内容

取消临时 Pix 限额申请

取消一个尚未使用的临时 Pix 限额申请，无论它是已获批还是仍在人工审核中。取消已获批的申请会从集成的自动审批上限中释放其申报额度；取消仍在审核中的申请则只是将其从队列中撤回，因为它尚未占用上限。

请求​

ENDPOINT
/baas/pix/exceptional_pix_request/PIX_REQUEST_KEY/cancel
方法
POST
警告

仅在 06:00 至 17:00（巴西利亚时间）之间可用。在该窗口之外，响应为 PXT000200。

该请求没有请求体。

Path Params​

字段类型描述字符数
pix_request_keyuuidv4需要取消的申请的唯一标识键。36

前置条件​

只有在以下全部条件成立时，取消才会被接受。任一条件不成立都会返回 PXT000201。

  • 该申请属于发起调用的请求方。
  • 该申请处于 pending_approval 或 approved 状态 —— 处于 rejected、cancelled 或 expired 的申请无法取消。
  • 要取消 approved 申请，该账户当日不得通过临时 Pix 转出任何金额。 首次转账之后（即使只是部分使用），该账户必须保持一个已获批申请直至 20:00 —— 包括替换了先前申请的新申请。已被拒绝的转账不计入已转出金额。如需提前判断取消是否会被接受，请使用查询临时 Pix 限额使用情况。pending_approval 申请可随时取消，无论是否已转出金额：它不授予任何额度，且已获批的申请仍在覆盖该账户。
信息

若要缩减或替换已在使用中的限额，请为同一账户创建新申请，且 total_amount 必须大于或等于当日已交易的金额。降额即时生效；增额需经 QI Tech 批准后才生效，在此之前先前的申请继续有效。参见 申请临时 Pix 限额。

响应​

Response Body: 200 OK
{
  "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": "cancelled",
  "message": "Request cancelled and no longer available for use."
}

Response Body Params​

字段类型描述
pix_request_keyuuidv4已取消申请的唯一标识键。
account_keyuuidv4该申请此前所适用的账户。
total_amountnumber此前申报的总额度。
request_reasonstring请求中填写的原因。
statusenumerator申请状态，本操作后为 cancelled。
messagestring状态的描述文本，为英文。

错误​

临时 Pix 的专属错误列于 Temporary Pix 错误表。本操作可能返回 PXT000200 和 PXT000201。