VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Pagamentos

Transações, estornos, divisão do pagamento entre sellers, taxas de gateway, configuração do PIX e disputas.

Esta área reúne o lado financeiro do pagamento de um pedido: o registro de cada cobrança nos gateways, o estorno quando é preciso devolver o dinheiro, a divisão do valor entre sellers, o custo do gateway, a configuração do PIX e as disputas abertas pelos clientes.

São as rotas do administrador da loja. O cliente paga pelo checkout da loja; o dinheiro dos sellers sai pelos repasses.

Pontos principais
  • Valores são inteiros em centavos (22500 = R$ 225,00). Taxas em pontos-base (250 = 2,5%).
  • Transações e PIX: view_payments ou manage_payments. Divisões: view_vendors ou manage_vendors, com o módulo direct-payments. Taxas: view_reports, com o módulo analytics. Disputas: qualquer administrador.
  • O estado das transações vem como letra (C, A, P, F, R, I); o das divisões e disputas, como palavra.
  • Um estorno é uma nova linha de transação, não uma alteração da cobrança.
  • O estorno é a única rota desta seção que movimenta dinheiro de verdade; não tem chave de idempotência.

Como funciona

O caminho de um pagamento

Cobrança (P)→Aprovada (A) ou Concluída (C)→Estornada (R)
LetraEstado da transaçãoSignificado
PpendenteCobrança criada, aguardando o cliente (por exemplo, PIX ainda não pago).
AaprovadaO gateway informou pago ou aprovado.
CconcluídaCobrança concluída. Também é o estado de uma linha de estorno bem-sucedida.
FfalhouRecusada ou com erro.
RestornadaO estorno cobriu todo o valor da cobrança.
IcanceladaCancelada antes de pagar.

Divisão entre sellers

Um pedido com itens de sellers diferentes gera uma divisão: uma fatia por seller e uma da loja, com a comissão descontada. A divisão é o registro do que cada um tem a receber daquele pagamento.

Disputas

O cliente contesta um pedido; o seller responde; sem acordo, o operador decide. Uma decisão com reembolso gera o estorno ao cliente e cobra o seller.

Conceitos-chave

Gateway

É a empresa que processa o pagamento (Pagar.me, Getnet e outras). Cada forma de pagamento da loja aponta para um gateway. O estorno é pedido a esse gateway.

Transação de pagamento

Uma tentativa de cobrança ou um estorno. Um pedido pode ter várias (tentativas que falharam, a que deu certo, estornos parciais).

Estorno parcial

A soma de todos os estornos de um pedido nunca passa do valor da cobrança. Ao cobrir o saldo, a cobrança original vira R.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/paymentsListar transaçõesTransações
POST/api/v1/admin/payments/{id}/refundEstornarTransações
GET/api/v1/admin/payment-splitsListar divisõesDivisão
GET/api/v1/admin/payment-splits/statsTotais das divisõesDivisão
PATCH/api/v1/admin/payment-splits/{id}/statusAlterar o estado de uma fatiaDivisão
GET/api/v1/admin/payment-feesConsultar taxas de gatewayTaxas
PUT/api/v1/admin/payment-feesSubstituir taxasTaxas
GET/api/v1/admin/pix/configConsultar o PIXPIX
PUT/api/v1/admin/pix/configGravar o PIXPIX
GET/api/v1/admin/disputesListar disputasDisputas
POST/api/v1/admin/disputes/{id}/resolveDecidir uma disputaDisputas

Erros comuns

  • Usar o id do pedido no estorno. A rota recebe o id da transação de pagamento.
  • Repetir um estorno depois de uma resposta perdida. Não há idempotência; confira a lista antes.
  • Filtrar transações por status=paid. Vira A e deixa de fora as concluídas (C). Use a letra.
  • Ler os contadores por estado de payment-splits/stats. Voltam 0; use o total da lista filtrada.
  • Enviar [] em PUT /payment-fees. Apaga todas as taxas.
  • Ligar o PIX sem segredo de webhook. Nenhum pagamento é confirmado e os pedidos expiram.
  • Tentar recusar uma disputa fora de escalated. A recusa só vale na mediação do operador.
  • Esperar 404 em UUID inexistente ou malformado. Várias rotas respondem 500 ou 400; leia o detail.

Próximos passos

Transações e estornos
Consulte cobranças e devolva dinheiro ao cliente.
Configuração do PIX
Defina a chave, o provedor e o segredo do webhook.
Disputas
Medie as contestações entre cliente e seller.
Anterior
Antecipações
Próxima
Transações e estornos
Nesta página
  • Como funciona
  • O caminho de um pagamento
  • Divisão entre sellers
  • Disputas
  • Conceitos-chave
  • Gateway
  • Transação de pagamento
  • Estorno parcial
  • Endpoints
  • Erros comuns
  • Próximos passos