Ir al contenido
A AmunPay API PixVersión 3.38 · actualizada el Páginas

Migrar desde otro gateway

Quien ya integró un gateway Pix reconoce cada operación. La tabla indica dónde está cada una aquí.

Operación por operación #

Lo que usted hacía Aquí
Crear un cobro o QR dinámico PUT /v2/cob/{txid}. El txid es suyo.
Consultar un cobro GET /v2/cob/{txid}
Listar cobros GET /v2/ex/cobrancas
Cancelar un cobro no pagado Depende de la cuenta: capacidades.cancelarCobranca en GET /v2/ex/config. Donde es false, deje que el cobro expire.
Transferencia, payout, Pix out PUT /v2/ex/pix/{idEnvio}. El idEnvio es suyo. Depende de la cuenta: capacidades.saque.
Consultar un payout GET /v2/ex/pix/{idEnvio}
Reembolsar un pago recibido PUT /v2/pix/{e2eId}/devolucao/{id}. Depende de la cuenta: donde capacidades.devolucao es false, la ruta responde 503 capacidade_indisponivel.
Saldo GET /v2/ex/saldo
Extracto o movimientos GET /v2/ex/extrato/{data} y GET /v2/ex/transacoes
Configurar webhook PUT /v2/ex/webhook
Reenviar un webhook perdido POST /v2/ex/webhook/reenvios o el feed GET /v2/ex/eventos
Subcuentas PUT /v2/ex/subcontas/{id} y ?subconta= en las consultas
Disputa GET /v2/ex/infracoes y los eventos med.infracao.*. La retención aparece en GET /v2/ex/saldo (bloqueado.med) y en GET /v2/ex/bloqueios. La defensa depende de la cuenta: capacidades.med en GET /v2/ex/config.
Encontrar una operación por cualquier id GET /v2/ex/transacoes/mapear?ref=

Las seis diferencias que cuestan dinero #

  1. El dinero es una cadena decimal. 150 y 150.0 se rechazan; "150.00" se acepta. No lo convierta a número de su lado.
  2. No existe un endpoint para generar QR. El pixCopiaECola viene en la respuesta de PUT /v2/cob/{txid}, y repetir la llamada con el mismo txid devuelve el mismo QR.
  3. Acredite a su cliente en pix.creditado, no en pix.recebido. El primero es saldo; el segundo todavía puede ser retenido o devuelto.
  4. Un rechazo nuestro a un Pix recibido llega como devolucao.criada con el motivo. Trate el default de su switch sobre motivo como un reembolso por decisión nuestra.
  5. 422 es una respuesta, no una falla: repetir en el acto produce el mismo 422. Trate el title. Algunos pasan cuando el saldo o el día cambian, como saldo_insuficiente y limite_excedido.
  6. "0.00" en su límite elimina su tope, y el de la institución sigue valiendo. No existe una cuenta sin límite.