Skip to main content
Retorna um movimento do extrato pelo txn_. É a leitura pontual do objeto transaction: quanto entrou ou saiu, quando liquida e o que foi descontado no caminho. Cada movimento pertence a uma única organização. A plataforma lê os próprios movimentos de fee; o lojista lê os movimentos da venda dele. Um txn_ que não pertence à organização autenticada responde 404, nunca 403 — o extrato de terceiro não existe do ponto de vista da sua key.

​
Autenticação

Escopo read é suficiente.

​
Parâmetros de caminho

​
string
required
ID do movimento (txn_*).
A leitura respeita o modo da chave: uma key de produção não enxerga movimentos de sandbox, e vice-versa. O mesmo txn_ consultado com a chave do modo errado responde 404.

​
Resposta

200 OK com o objeto transaction completo — mesmo shape retornado por GET /v1/transactions e descrito campo a campo em O objeto Transaction. Duas coisas que o seu parser precisa suportar desde a primeira integração:
  • amount e net_amount têm sinal. Entrada é positiva, saída é negativa. Somar uma página é somar o extrato, sem tratar estorno como caso especial.
  • net_amount = amount - fee_amount, em todo tipo de movimento, e fee_amount é a soma exata de fee_details[].amount. Se fee_details vier [], fee_amount é 0.
settled_at só é preenchido quando status é paid. Enquanto o movimento está pending, use available_at como previsão — e trate null ali como “data ainda não definida”, não como “liquida hoje”.

​
Erros comuns

O txn_ não existe, pertence a outra organização, ou foi consultado com uma key do outro modo — os três casos respondem igual, de propósito:
404
401
O extrato é somente leitura: ele é gerado pelo processamento do pagamento, nunca criado ou alterado por integração. Qualquer verbo diferente de GET responde 405.
405