Skip to main content

reference é a chave de ligação

Envie o seu identificador em reference na criação da cobrança. Ele volta na consulta e nos webhooks, e serve de filtro em GET /v1/charges. É o que permite casar a cobrança com o seu pedido sem guardar o id que devolvemos — útil no dia em que a sua tabela de pedidos perdeu a coluna, ou quando alguém do financeiro precisa achar uma venda a partir do número do pedido e não tem acesso ao seu banco.
Reencontrar pelo seu número de pedido

Fechando um período

Combine status, created_from e created_to:
Tudo que foi pago em agosto
As datas são ISO 8601 e filtram por criação, não por pagamento. Uma cobrança criada em 31 de julho e paga em 1º de agosto não aparece no filtro de agosto — vale conferir a borda do período contra paid_at quando o relatório precisa fechar por competência.

Paginação

O teto é 100 itens por página, e o padrão é 25. O limite existe porque uma página gigante de um vendedor com histórico degrada a consulta para todos os outros.
Pare por has_more, não por página vazia. E respeite a cota de leitura — ver Limites de requisição.

Os números que fecham a conta

platform_fee é congelada na criação. Ela reflete o contrato que valia quando a venda aconteceu, não o de hoje. Recalcular a taxa pela tabela atual ao conciliar vendas antigas produz uma diferença que não existe.
Uma cobrança partially_refunded ainda tem receita: o que sobrou é amount - refunded_amount. Tratá-la como refunded descontaria o valor inteiro. Ver Ciclo de vida.

A lista só enxerga a sua conta

GET /v1/charges devolve apenas as cobranças do vendedor dono da chave. Não existe forma de alcançar a venda de outra conta por esta API — e o 404 de uma cobrança alheia é o mesmo 404 de uma que não existe, para que ninguém descubra códigos válidos por tentativa.

Veja também

Listar cobranças

Todos os filtros disponíveis.

Saldo do vendedor

O outro lado da conta.

Ficou algo de fora? Escreva para suporte@usevext.com. Se o assunto for uma chamada específica, informe o horário dela; se for uma entrega de webhook, informe o X-Vext-Delivery — é por ele que localizamos a tentativa, a resposta do seu servidor e o horário.