A API v1 continua disponível. Veja Migrando da v1 para entender o que muda.
Convenções
Conceitos
Pedido (order)
A compra do cliente. Reúne os itens e um ou mais pagamentos (por exemplo, dois cartões ou cartão + PIX).
Pagamento (payment_intent)
Cada meio de pagamento dentro de um pedido ou fatura. O
id do pagamento é o mesmo id da cobrança.Cobrança (charge)
A visão financeira de um pagamento: quanto foi pago, estornado e ainda pode ser estornado.
Cartão (card)
Um cartão salvo do cliente. Use o
id como card.token em pedidos, assinaturas e faturas.Assinatura (subscription)
Cobrança recorrente. Cada ciclo gera uma fatura.
Fatura (invoice)
Uma cobrança de um ciclo da assinatura, com os próprios pagamentos e status.
Recursos e rotas
Como um pagamento acontece
- Você cria o pedido com
POST /v2/orders. - A resposta traz o
statusdo pedido e, quando o cliente precisa agir, umnext_action(QR Code PIX ou código de verificação). - A confirmação final chega por webhook (
order.paid,charge.paid).
Uma resposta
402 também traz o recurso completo, com status: "failed" e o motivo em failure_reason. Veja Pagamento recusado.Próximos passos
Autenticação
Envie a sua chave de API em todas as chamadas.
Criar pedido
Cobre com cartão, PIX ou os dois no mesmo pedido.
Erros
Formato de erro e catálogo de códigos.
Webhooks
Receba a confirmação dos pagamentos.
