申请临时 Pix 限额
为请求方自有的账户申请当日的临时 Pix 限额:计划通过临时通道交易的 Pix 总额度。
请求
ENDPOINT
/baas/pix/exceptional_pix_request方法
POST警告
仅在 06:00 至 17:00(巴西利亚时间)之间可用。在该窗口之外,响应为 PXT000200。
Request Body
{
"account_key": "0f2a1e4c-1111-2222-3333-444455556666",
"total_amount": 1200000.00,
"request_reason": "folha de pagamento do cliente Alfa Ltda"
}
Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key * | uuidv4 | 限额所适用账户的唯一标识键,该账户须为请求方自有。 | 36 |
total_amount * | number | 该账户当日临时 Pix 限额的总额度。不得低于当日已交易的金额。 | — |
request_reason * | string | 需要临时额度的原因。如需人工审核,QI Tech 将参考该说明。 | 3 至 255 |
响应
存在两种成功响应,两者的差异决定了限额是否可以立即使用:
| HTTP 状态码 | status | 含义 |
|---|---|---|
| 201 | approved | 在集成的自动审批上限之内。限额当日即可用于转账。 |
| 202 | pending_approval | 超出自动审批上限。转入 QI Tech 人工审核,可能获批或被拒;审核期间不可用。 |
202 不等于获批
返回 202 与 pending_approval 时,申请已被记录,但不会放开转账。在该状态下尝试转账将响应 PXT000201。审核结果通过 baas.pix.exceptional.approved 或 baas.pix.exceptional.rejected Webhook 通知,也可通过
查询限额申请 跟踪。
信息
若为已有开放申请的账户创建新申请,额度不会累加。若先前的申请处于 approved,且新的 total_amount 小于或等于其额度,则新申请即时获批,先前的申请变为 cancelled。若新的 total_amount 更高,则新申请处于 pending_approval,而先前的申请保持已获批且可用,直至 QI Tech 处理 —— 批准后先前的申请变为 cancelled,被拒绝后先前的申请继续有效。参见
注意事项。
Response Body: 201 Created
{
"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."
}
Response Body: 202 Accepted
{
"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": "pending_approval",
"message": "Request received and forwarded to manual analysis. The result will be sent by webhook."
}
Response Body Params
| 字段 | 类型 | 描述 |
|---|---|---|
pix_request_key | uuidv4 | 临时 Pix 限额申请的唯一标识键。 |
account_key | uuidv4 | 该申请所适用的账户。 |
total_amount | number | 当日申报的总额度。 |
request_reason | string | 请求中填写的原因。 |
status | enumerator | 申请状态。参见 Temporary Pix Request Status。 |
message | string | 状态的描述文本,为英文。 |
错误
临时 Pix 的专属错误列于
Temporary Pix 错误表。本操作可能返回 PXT000206、PXT000200 和 PXT000202。