跳到正文
A AmunPay API Pix版本 3.38 · 更新于 页面

限额

您的账户适用的单笔上限、按付款人 CPF 的上限,以及按提现收款人的上限。查询结果始终是当前生效的上限。在向您的客户承诺大额之前,请先查询。

GET /v2/ex/limites

权限范围:ex.limites.read。

GET /v2/ex/limites
→ 200
{
  "maxDeposito": "15000.00",
  "maxSaque": "15000.00",
  "diarioDepositoCpf": "50000.00",
  "diarioSaqueCpf": "50000.00",
  "mensalDepositoCpf": "500000.00",
  "mensalSaqueCpf": "500000.00",
  "impostoPelaIP": ["maxDeposito", "maxSaque", "diarioDepositoCpf", "diarioSaqueCpf", "mensalDepositoCpf", "mensalSaqueCpf"]
}
字段 类型 说明
maxDeposito 字符串 每笔收款的上限。
maxSaque 字符串 每笔提现的上限。
diarioDepositoCpf、diarioSaqueCpf 字符串 每个会计日的上限:存款按付款人 CPF 计算,提现按收款人(CPF 或 CNPJ)计算。
mensalDepositoCpf、mensalSaqueCpf 字符串 每个自然月的上限,计算规则与每日上限相同。
impostoPelaIP 列表 上限由机构设定的字段。这些字段不能通过 API 调高。
pedidoPendente 对象 仅当有提额请求正在等待 24 小时时出现。包含 campos、valores 和 efetivaEm。

上限值为 0.00 表示不设上限。

修改 #

PUT /v2/ex/limites

权限范围:ex.limites.write。

正文是部分更新:省略的字段保持不变。降低立即生效。提高会变成一项请求,24 小时后生效,并显示在 pedidoPendente 中。设为 "0.00" 或 "" 会取消您自定义的上限。这属于提高:24 小时后适用机构的上限,该字段会出现在 impostoPelaIP 中。

PUT /v2/ex/limites
{
  "maxSaque": "1000.00"
}
→ 200
{
  "maxDeposito": "15000.00",
  "maxSaque": "1000.00",
  "diarioDepositoCpf": "50000.00",
  "diarioSaqueCpf": "50000.00",
  "mensalDepositoCpf": "500000.00",
  "mensalSaqueCpf": "500000.00",
  "impostoPelaIP": ["maxDeposito", "diarioDepositoCpf", "diarioSaqueCpf", "mensalDepositoCpf", "mensalSaqueCpf"]
}

提现超过上限时,返回 422 limite_excedido,violacoes 中包含 tipoLimite、limite 和 disponivel。收款的上限在 Pix 到达时生效:收款照常创建,超过上限的付款会被拒绝,并触发事件 cob.pagamento_rejeitado(原因为 LIMITE_EXCEDIDO)。在某些账户中,该款项还会通过 devolucao.criada 退还付款人。

部分账户对每笔提现 Pix 设有的最高金额不属于这些上限:它来自账户本身,无法在此修改,超过该金额的提现返回 422 valor_acima_do_maximo(见创建提现)。

错误 #

状态码 title 触发条件
400 valor_invalido 金额不符合 "0.00" 格式。
400 campo_desconhecido 正文不是有效的 JSON,包含六个上限以外的字段,或某个值不是文本,例如用 1000 代替 "1000.00"。