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. |
| Consultar um payout | GET /v2/ex/pix/{idEnvio} |
| Estornar um recebimento | PUT /v2/pix/{e2eId}/devolucao/{id} |
| 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 | Não faz parte desta API. A retenção aparece em GET /v2/ex/saldo (bloqueado.med) e em GET /v2/ex/bloqueios. |
| Achar uma operação por qualquer id | GET /v2/ex/transacoes/mapear?ref= |
As seis diferenças que custam dinheiro #
- Dinheiro é string decimal.
150e150.0são recusados;"150.00"é aceito. Não converta para número no seu lado. - Não existe endpoint para gerar QR. O
pixCopiaEColavem na resposta dePUT /v2/cob/{txid}, e repetir a chamada com o mesmotxiddevolve o mesmo QR. - Credite o seu cliente em
pix.creditado, não empix.recebido. O primeiro é saldo; o segundo ainda pode ser retido ou devolvido. - Uma recusa nossa a um Pix recebido chega como
devolucao.criadacom omotivo. Trate odefaultdo seuswitchsobremotivocomo estorno por decisão nossa. 422é resposta, não falha. Repetir a mesma chamada produz o mesmo422. Trate otitle."0.00"em um limite é ausência de limite, não limite zero.