Ir para o conteúdo
A AmunPay API PixVersão 3.38 · atualizada em Páginas

Limites

Os tetos por transação, por CPF do pagador e por favorecido do saque que valem na sua conta. A consulta mostra sempre o teto que vale hoje. Consulte antes de prometer um valor alto ao seu cliente.

GET /v2/ex/limites

Escopo: 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"]
}
Campo Tipo Descrição
maxDeposito string Teto por cobrança.
maxSaque string Teto por saque.
diarioDepositoCpf, diarioSaqueCpf string Teto por dia contábil: no depósito, por CPF do pagador; no saque, por favorecido, CPF ou CNPJ.
mensalDepositoCpf, mensalSaqueCpf string Teto por mês civil, com a mesma régua do diário.
impostoPelaIP lista Os campos cujo teto é o da instituição. Você não sobe esses pela API.
pedidoPendente objeto Só aparece quando há um aumento aguardando as 24 horas. Traz campos, valores e efetivaEm.

Um teto com o valor 0.00 quer dizer sem teto.

Alterar #

PUT /v2/ex/limites

Escopo: ex.limites.write.

O corpo é parcial: campo omitido fica como está. Reduzir vale na hora. Aumentar vira pedido que efetiva em 24 horas e aparece em pedidoPendente. Passar para "0.00" ou "" tira o seu teto próprio. É aumento: depois das 24 horas vale o da instituição, e o campo aparece em 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"]
}

No saque, acima de um teto a resposta é 422 limite_excedido, com tipoLimite, limite e disponivel em violacoes. Na cobrança o teto vale quando o Pix chega: a cobrança é criada, e o pagamento acima do teto é recusado com o evento cob.pagamento_rejeitado (motivo LIMITE_EXCEDIDO). Em algumas contas ele também volta ao pagador, com devolucao.criada.

O máximo por Pix de saque de algumas contas não é um destes tetos: ele vem da conta, não muda por aqui, e acima dele o saque responde 422 valor_acima_do_maximo (ver Criar saque).

Erros #

Status title Quando
400 valor_invalido Valor fora do formato "0.00".
400 campo_desconhecido O corpo não é JSON válido, trouxe um campo que não é um dos seis tetos ou um valor que não é texto, como 1000 no lugar de "1000.00".