> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Visão Geral

> Includes disponíveis para consulta de gateways de pagamento em {alias}/checkout/gateways

## 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](https://docs.yampi.com.br/api-reference/checkout/listar-gateways-de-pagamento) e [documentação de visualização de um gateway específico](https://docs.yampi.com.br/api-reference/checkout/visualizar-gateway-de-pagamento), 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`

| Include | Descrição                                               |
| ------- | ------------------------------------------------------- |
| `form`  | Campos necessários para configurar a forma de pagamento |

***

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

```http theme={"system"}
GET {alias}/checkout/gateways?include=form
```