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

Conciliação de um seller

Compara o que os pedidos de um seller deveriam render com o que o Pagar.me de fato repassou no período.

Conciliar é conferir se o dinheiro que entrou bate com o que deveria entrar. Esta rota pega, para um seller e um período, a soma dos pedidos da loja (o esperado) e a soma dos repasses pagos pelo gateway ao recebedor dele (o realizado), e devolve a diferença e a taxa de acerto. Serve para achar um pedido que não foi repassado, um estorno que não foi descontado ou uma taxa inesperada. Exige o módulo pagarme e o privilégio manage_payments ou view_payments.

Conciliar um seller

GET/api/v1/admin/pagarme/reconciliationAdmin

Concilia pedidos e repasses de um seller

Parâmetros de consulta

vendor_iduuidobrigatório
Seller a conciliar.
fromstring
Início do período, YYYY-MM-DD. Padrão: 30 dias atrás.
untilstring
Fim do período, YYYY-MM-DD, inclusive. Padrão: hoje.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/pagarme/reconciliation?vendor_id=ec5e10b3-8cb1-43e9-9aa8-964b64eda8de&from=2026-09-01&until=2026-09-30" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Conciliação calculada
json
{
  "vendor_id": "ec5e10b3-8cb1-43e9-9aa8-964b64eda8de",
  "date_from": "2026-09-01",
  "date_until": "2026-09-30",
  "total_expected": 250000,
  "total_actual_gross": 245000,
  "total_actual_net": 236250,
  "total_fees": 8750,
  "difference": 5000,
  "match_rate": 98,
  "orders": [
    { "id": "6c1b45aa-1acd-4576-95ac-1c684454bd31", "total": 68040, "status": "complete", "created_at": "2026-09-14T06:50:07Z" }
  ],
  "payables": [
    {
      "id": 912345,
      "status": "paid",
      "type": "credit",
      "amount": 68040,
      "fee": 2041,
      "anticipation_fee": 0,
      "payment_date": "2026-09-15",
      "charge_id": "ch_Z1dxXYKcNWcnw547",
      "transaction_id": 77123456,
      "recipient_id": "re_cm0sellerexampleexample0001",
      "split_id": "split_xxx"
    }
  ]
}

Campos da resposta

vendor_iduuid
Seller.
date_fromstring
Início usado, YYYY-MM-DD.
date_untilstring
Fim usado, YYYY-MM-DD.
total_expectedinteger
Soma, em centavos, dos totais dos pedidos do seller criados no período.
total_actual_grossinteger
Soma bruta, em centavos, dos repasses pagos no período. Estornos e chargebacks entram como valores negativos.
total_actual_netinteger
Bruto menos as taxas, em centavos.
total_feesinteger
Soma das taxas cobradas pelo gateway, em centavos.
differenceinteger
total_expected menos total_actual_gross, em centavos. Positivo significa que falta receber.
match_ratenumber
Percentual de acerto de 0 a 100, com uma casa decimal: 100 menos a diferença relativa ao esperado. 0 quando não há esperado.
ordersarray
Até 500 pedidos do período, os mais novos primeiro: id, total (centavos), status e created_at.
payablesarray
Repasses do gateway (primeira página, até 100): id, status, type (credit, refund, chargeback...), amount, fee, anticipation_fee, payment_date, charge_id, transaction_id, recipient_id, split_id. Valores em centavos.
reasonstring
Presente quando os repasses não puderam ser lidos (sem chave de API, seller sem recebedor, erro do gateway). Os pedidos ainda vêm.

Erros

StatusQuandoCorpo
400Sem vendor_id{"error":"vendor_id required"}
500vendor_id ou datas em formato inválido{"error":"failed to reconcile","detail":"a database error occurred"}

Seller sem recebedor ou loja sem chave de API não é erro: a resposta é 200 com os pedidos, totais realizados em zero e o motivo em reason (por exemplo pagarme: vendor has no recipient).

Leia os totais com os limites em mente

O esperado soma todos os pedidos do seller no período, inclusive cancelados e ainda não pagos, e só considera os 500 mais novos. O realizado considera só a primeira página (100) de repasses pagos. Em sellers de alto volume, estreite o período (por exemplo, um dia) antes de concluir que há diferença.

Diferença não é necessariamente erro

Repasses chegam dias depois da venda (conforme o prazo do cartão), então pedidos do fim do período costumam aparecer como "faltando". Compare períodos já fechados ou ajuste until para alguns dias antes de hoje.

Veja também

  • Recebedores
  • Cobranças
Anterior
Recebedores do split
Próxima
Webhooks do Pagar.me
Nesta página
  • Conciliar um seller
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também