API v1
Começar

Changelog

Mudanças na API v1. Dentro da v1 tudo é aditivo: nada que já funciona deixa de funcionar.

Catálogo de produtos

  • Novos GET /v1/products e GET /v1/products/{productId} com o escopo charges:read: os produtos ativos cadastrados no painel.
  • POST /v1/charges aceita product_id; o amount_cents tem de ser o price_cents atual do produto, senão a resposta é product_unavailable.
  • A cobrança traz product_id quando foi criada com um produto.

Cobranças e saques mais completos, eventos e novas listas

  • Novo GET /v1/charges: lista cobranças com filtros por status, external_id e período.
  • Novo GET /v1/withdrawals: lista saques com os mesmos filtros.
  • Novos GET /v1/events e GET /v1/events/{eventId} com o escopo events:read: os mesmos eventos dos webhooks, para conciliar o que você perdeu.
  • A cobrança agora traz description, metadata, payer, paid_by (quem pagou, segundo o banco), end_to_end_id e reversed_at.
  • POST /v1/charges aceita metadata e expires_in_seconds, e responde com a cobrança completa.
  • O saque agora traz description, metadata, recipient (nome e banco confirmados), end_to_end_id, failure_reason, completed_at e updated_at.
  • Todo webhook traz data.object com o recurso completo. Os campos antigos continuam iguais.
  • Novos eventos charge.created e withdrawal.created.
  • Erros da API pública agora trazem message e doc_url; request_id passa a ter o formato req_ seguido de um UUID.