​
Introdução

Esta página documenta o include disponível para os endpoints relacionados a gateways de pagamento.

Com o uso do parâmetro include, é possível enriquecer a resposta da API com dados relacionados aos campos necessários para configurar a forma de pagamento, quando aplicável.

Você encontrará aqui:

  • Descrição do include suportado.
  • Exemplos práticos de uso em requisições de listagem e consulta de gateway.

Esta página complementa a documentação de listagem dos gateways de pagamento e documentação de visualização de um gateway específico, com foco na personalização da resposta para integrações avançadas.

​
Includes disponíveis para gateways de pagamento (/checkout/gateways e /checkout/gateways/{alias})

Use o parâmetro include para expandir o retorno com dados relacionados ao gateway.

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

IncludeDescrição
formCampos necessários para configurar a forma de pagamento

​
Exemplo de requisição para listar gateways com includes

GET {alias}/checkout/gateways?include=form