​
Introdução

Esta página documenta os includes disponíveis para os endpoints relacionados às transações do checkout, permitindo expandir a resposta da API com informações detalhadas sobre afiliação, dados do cliente, forma de pagamento, requisição original e logs da transação.

Você encontrará aqui:

  • Descrição dos includes suportados para listagem e visualização de transações.
  • Exemplos práticos de uso com múltiplos includes combinados.

Esta página complementa a documentação de listagem de transações e documentação de consulta de transação específica, com foco na visibilidade e rastreabilidade de eventos financeiros.

​
Includes disponíveis nas rotas de transações (/checkout/transactions e /checkout/transactions/{id})

Use o parâmetro include para expandir o retorno com dados relacionados à transação.

Você pode incluir múltiplos valores separados por vírgula, por exemplo:
?include=payment,customer,logs

IncludeDescrição
affiliationDados da afiliação envolvida na transação (se aplicável)
paymentInformações do método de pagamento
customerDados do cliente relacionado à transação
requestDataDados brutos enviados na requisição da transação
logsHistórico de eventos e mudanças na transação

​
Exemplo completo de requisição com includes

GET {alias}/checkout/transactions?include=payment,customer,logs