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

Migrando de outro gateway

Quem já integrou um gateway Pix reconhece cada operação. A tabela diz onde cada uma está aqui.

Operação a operação #

O que você fazia Aqui
Criar cobrança ou QR dinâmico PUT /v2/cob/{txid}. O txid é seu.
Consultar uma cobrança GET /v2/cob/{txid}
Listar cobranças GET /v2/ex/cobrancas
Cancelar uma cobrança não paga Depende da conta: capacidades.cancelarCobranca em GET /v2/ex/config. Onde é false, deixe a cobrança expirar.
Transferência, payout, Pix out PUT /v2/ex/pix/{idEnvio}. O idEnvio é seu. Depende da conta: capacidades.saque.
Consultar um payout GET /v2/ex/pix/{idEnvio}
Estornar um recebimento PUT /v2/pix/{e2eId}/devolucao/{id}. Depende da conta: onde capacidades.devolucao é false, a rota responde 503 capacidade_indisponivel.
Saldo GET /v2/ex/saldo
Extrato ou movimentações GET /v2/ex/extrato/{data} e GET /v2/ex/transacoes
Configurar webhook PUT /v2/ex/webhook
Reenviar um webhook perdido POST /v2/ex/webhook/reenvios ou o feed GET /v2/ex/eventos
Sub-contas PUT /v2/ex/subcontas/{id} e ?subconta= nas consultas
Contestação GET /v2/ex/infracoes e os eventos med.infracao.*. A retenção aparece em GET /v2/ex/saldo (bloqueado.med) e em GET /v2/ex/bloqueios. A defesa depende da conta: capacidades.med em GET /v2/ex/config.
Achar uma operação por qualquer id GET /v2/ex/transacoes/mapear?ref=

As seis diferenças que custam dinheiro #

  1. Dinheiro é string decimal. 150 e 150.0 são recusados; "150.00" é aceito. Não converta para número no seu lado.
  2. Não existe endpoint para gerar QR. O pixCopiaECola vem na resposta de PUT /v2/cob/{txid}, e repetir a chamada com o mesmo txid devolve o mesmo QR.
  3. Credite o seu cliente em pix.creditado, não em pix.recebido. O primeiro é saldo; o segundo ainda pode ser retido ou devolvido.
  4. Uma recusa nossa a um Pix recebido chega como devolucao.criada com o motivo. Trate o default do seu switch sobre motivo como estorno por decisão nossa.
  5. 422 é resposta, não falha: repetir na hora produz o mesmo 422. Trate o title. Alguns passam quando o saldo ou o dia mudam, como saldo_insuficiente e limite_excedido.
  6. "0.00" no seu limite remove o seu teto, e o da instituição continua valendo. Não existe conta sem limite.