> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Consultar checkout > Devolve a configuração completa de um checkout da empresa autenticada — meios de pagamento, parcelamento, campos do formulário e aparência —, para editar no seu próprio painel ou pré-visualizar antes de divulgar. Responde 404 quando o checkout não existe, foi excluído ou pertence a outra empresa. ## OpenAPI ````yaml /openapi.yaml get /v1/checkouts/{checkoutId} openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/checkouts/{checkoutId}: get: tags: - Checkout summary: Consultar checkout description: >- Devolve a configuração completa de um checkout da empresa autenticada — meios de pagamento, parcelamento, campos do formulário e aparência —, para editar no seu próprio painel ou pré-visualizar antes de divulgar. Responde 404 quando o checkout não existe, foi excluído ou pertence a outra empresa. operationId: getCheckout parameters: - schema: type: string minLength: 1 in: path name: checkoutId required: true description: Identificador do checkout. responses: '200': description: Configuração do checkout. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: string description: Identificador do checkout. version: type: string enum: - v1 - v2 description: >- Geração do construtor que criou o checkout: `v1` (antigo) ou `v2` (atual). checkoutName: type: string description: >- Nome interno do checkout, usado pelo vendedor para diferenciar variações. productId: type: string description: Produto ao qual o checkout pertence. active: type: boolean description: >- `false` quando o checkout foi excluído e parou de atender no link público. slug: type: string nullable: true description: >- Identificador curto do checkout na URL pública. Só em checkouts `v2`. isDefault: type: boolean nullable: true description: >- Se este é o checkout padrão do produto. Só em checkouts `v1`; `null` em `v2`. model: type: string nullable: true description: >- Modelo de layout do construtor antigo. Só em checkouts `v1`. billingType: type: string enum: - one_time - subscription nullable: true description: >- Cobrança única ou recorrente deste checkout. Só em checkouts `v2`. acceptMethod: type: array items: type: string enum: - pix - credit_card - boleto - multiple_cards description: >- Meio de pagamento gravado no checkout. Pode trazer `boleto` em checkouts antigos. description: Meios de pagamento que o comprador pode escolher. preferredPaymentMethod: type: string enum: - pix - credit_card - boleto - multiple_cards description: Meio de pagamento aberto por padrão na página. nullable: true maxInstallments: type: integer nullable: true description: Número máximo de parcelas oferecido no cartão. defaultOfferId: type: integer nullable: true description: Oferta que abre pela URL do checkout. Só em `v2`. preDefinedInstallmentEnabled: type: boolean nullable: true description: >- Se a página já abre com uma parcela pré-selecionada. Só em `v2`. preDefinedInstallmentValue: type: integer nullable: true description: Parcela pré-selecionada. Só em `v2`. collectBuyerAddress: type: boolean nullable: true description: >- Se o formulário pede o endereço do comprador. Só em `v2`. askBuyerInstagram: type: boolean nullable: true description: >- Se o formulário pede o Instagram do comprador. Só em `v2`. enableAddressAutofill: type: boolean nullable: true description: Se o endereço é preenchido pelo CEP. Só em `v2`. collectInstagram: type: boolean description: Se o checkout coleta o Instagram do comprador. upsellEnabled: type: boolean nullable: true description: Se o funil pós-compra está ligado. Só em `v2`. upsellRedirectUrl: type: string nullable: true description: Para onde o comprador vai após a compra. Só em `v2`. imageUrl: type: string nullable: true description: Imagem do produto exibida na página do checkout. marketLanguage: type: string nullable: true description: Idioma/mercado da página do checkout. invoiceName: type: string nullable: true description: Nome que aparece na fatura do cartão do comprador. billetExpireTime: type: integer nullable: true description: Dias até o vencimento do boleto gerado. allowedDoubleCard: type: boolean description: >- Se o comprador pode dividir o pagamento em dois cartões. allowedCardPix: type: boolean description: >- Se o comprador pode pagar parte no cartão e parte no Pix. allowedSmartInstallment: type: boolean description: Se o Parcelamento Inteligente está disponível. createdAt: type: string format: date-time description: Momento de criação do checkout. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - version - checkoutName - productId - active - slug - isDefault - model - billingType - acceptMethod - preferredPaymentMethod - maxInstallments - defaultOfferId - preDefinedInstallmentEnabled - preDefinedInstallmentValue - collectBuyerAddress - askBuyerInstagram - enableAddressAutofill - collectInstagram - upsellEnabled - upsellRedirectUrl - imageUrl - marketLanguage - invoiceName - billetExpireTime - allowedDoubleCard - allowedCardPix - allowedSmartInstallment - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Configuração do checkout. example: success: true data: id: clx9f1m2p0004qz0a7h8j9k0l version: v2 checkoutName: Checkout principal productId: clx8a2h4k0001qz0a1b2c3d4e active: true slug: trafego-pago-2026 isDefault: null model: null billingType: one_time acceptMethod: - pix - credit_card preferredPaymentMethod: pix maxInstallments: 12 defaultOfferId: 4821 preDefinedInstallmentEnabled: true preDefinedInstallmentValue: 12 collectBuyerAddress: false askBuyerInstagram: false enableAddressAutofill: true collectInstagram: false upsellEnabled: true upsellRedirectUrl: https://exemplo.com.br/obrigado imageUrl: >- https://images.ephra.io/checkouts/clx9f1m2p0004qz0a7h8j9k0l.jpg marketLanguage: pt-BR invoiceName: EPHRA*TRAFEGO billetExpireTime: 3 allowedDoubleCard: true allowedCardPix: false allowedSmartInstallment: true createdAt: '2026-09-02T10:15:00.000Z' updatedAt: '2026-09-11T17:40:00.000Z' '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Checkout não encontrado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````