> ## 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.

# Listar transações de pedidos

> Lista todas as transações de checkout de uma loja específica



## OpenAPI

````yaml get /{alias}/checkout/transactions
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/checkout/transactions:
    get:
      tags:
        - Checkout - Transações
      summary: Listar transações de pedidos
      description: Lista todas as transações de checkout de uma loja específica
      operationId: GetCheckoutTransactions
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lista de transações
          content:
            application/json:
              schema:
                allOf:
                  - properties:
                      data:
                        description: Transações de pagamento dos pedidos da loja.
                        type: array
                        items:
                          allOf:
                            - $ref: '#/components/schemas/Transaction'
                            - $ref: >-
                                #/components/schemas/TransactionAdditionalResponse
                    type: object
                  - $ref: '#/components/schemas/SimplePaginatorWithMeta'
        '400':
          description: Requisição inválida
        '404':
          description: Transações não encontradas
components:
  schemas:
    Transaction:
      title: Transações financeiras de um pedido
      description: >-
        Tentativa de pagamento processada pela adquirente/gateway para um
        carrinho ou pedido.
      properties:
        id:
          description: Identificador único da transação.
          type: integer
        customer_id:
          description: ID do cliente que fez o pagamento.
          type: integer
        payment_id:
          description: ID do meio de pagamento usado na transação.
          type: integer
        affiliation_id:
          description: >-
            ID da afiliação de pagamento (adquirente/gateway) que processou a
            transação.
          type: integer
        marketplace_id:
          description: ID do marketplace de origem da transação, quando aplicável.
          type: integer
        marketplace_account_id:
          description: ID da conta do marketplace usada na transação, quando aplicável.
          type: integer
        authorized:
          description: Indica se a transação foi autorizada pela adquirente/gateway.
          type: boolean
        captured:
          description: Indica se a transação foi capturada (pagamento efetivado).
          type: boolean
        cancelled:
          description: Indica se a transação foi cancelada.
          type: boolean
        can_be_captured:
          description: >-
            Indica se a transação pode ser capturada: exige transação
            autorizada, não cancelada, ainda não paga e meio de pagamento
            diferente de carteira digital e de Pix parcelado.
          type: boolean
        can_be_cancelled:
          description: >-
            Indica se a transação pode ser cancelada: exige transação não
            cancelada e meio de pagamento diferente de carteira digital e de Pix
            parcelado.
          type: boolean
        gateway_transaction_id:
          description: ID da transação no gateway de pagamento.
          type: integer
        gateway_order_id:
          description: ID do pedido correspondente no gateway de pagamento.
          type: integer
        gateway_authorization_code:
          description: Código de autorização devolvido pela adquirente/gateway.
          type: string
        gateway_billet_id:
          description: >-
            ID do boleto no gateway de pagamento, quando o meio de pagamento for
            boleto.
          type: integer
        amount:
          description: Valor total da transação, em reais.
          type: number
          format: float
        buyer_amount:
          description: >-
            Valor total cobrado do comprador, em reais, incluindo os juros do
            parcelamento.
          type: number
          format: float
        installment_value:
          description: >-
            Valor de cada parcela da transação, em reais; zero quando não há
            parcelamento.
          type: number
          format: float
        buyer_installment_value:
          description: >-
            Valor de cada parcela cobrada do comprador, em reais; zero quando
            não há parcelamento.
          type: number
          format: float
        installments:
          description: Número de parcelas da transação.
          type: integer
        installment_formated:
          description: >-
            Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de
            parcelas e o valor total da transação.
          type: string
        buyer_installment_formated:
          description: >-
            Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de
            parcelas e o valor total cobrado do comprador.
          type: string
        status:
          description: >-
            Status da transação (`waiting_payment`, `authorized`, `paid`,
            `refused`, `cancelled` ou `handling_products`).
          type: string
        error_message:
          description: >-
            Mensagem de erro devolvida pela adquirente/gateway quando a
            transação não é aprovada.
          type: string
        bank_name:
          description: >-
            Nome do banco usado no pagamento; preenchido apenas em pagamentos
            por depósito.
          type: string
        bank_alias:
          description: >-
            Alias do banco usado no pagamento, derivado do nome; preenchido
            apenas em pagamentos por depósito.
          type: string
        truncated_card:
          description: >-
            Número parcial do cartão usado no pagamento, sem os dígitos
            sensíveis.
          type: string
        holder_name:
          description: >-
            Nome do titular do cartão ou do meio de pagamento usado na
            transação.
          type: string
        holder_document:
          description: >-
            Documento (CPF/CNPJ) do titular do cartão ou do meio de pagamento
            usado na transação.
          type: string
        billet_url:
          description: >-
            URL do boleto gerado para a transação, quando o meio de pagamento
            for boleto.
          type: string
        billet_barcode:
          description: Código de barras do boleto gerado para a transação.
          type: string
        billet_date:
          description: Data de vencimento do boleto gerado para a transação.
          type: string
        billet_our_number:
          description: Nosso número do boleto, identificador atribuído pelo banco emissor.
          type: string
        billet_document_number:
          description: >-
            Número do documento do boleto, usado pelo banco emissor para
            identificar a cobrança.
          type: string
        billet_whatsapp_link:
          description: >-
            Link do WhatsApp com a mensagem de cobrança do boleto pronta para
            envio ao cliente.
          type: string
        antifraud_sale_id:
          description: ID da análise da transação no serviço de antifraude.
          type: integer
        antifraud_status:
          description: Status devolvido pelo serviço de antifraude para a transação.
          type: string
        antifraud_score:
          description: Pontuação de risco atribuída pelo serviço de antifraude à transação.
          type: string
        sent_to_antifraud:
          description: Indica se a transação foi enviada para análise de antifraude.
          type: string
        total_logs:
          description: Quantidade de registros de log da transação.
          type: integer
        error_code:
          description: >-
            Código do erro devolvido pela adquirente/gateway quando a transação
            não é aprovada.
          type: integer
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
        capture_date:
          $ref: '#/components/schemas/BaseTimestamp'
        authorized_at:
          $ref: '#/components/schemas/BaseTimestamp'
        captured_at:
          $ref: '#/components/schemas/BaseTimestamp'
        cancelled_at:
          $ref: '#/components/schemas/BaseTimestamp'
      type: object
    TransactionAdditionalResponse:
      title: Dados adicionais da transação
      description: >-
        Dados retornados junto da transação por meio de includes; `payment` e
        `metadata` vêm por padrão.
      properties:
        payment:
          description: Informações sobre o meio de pagamento
          properties:
            data:
              description: Detalhes do pagamento
              properties:
                id:
                  description: ID do meio de pagamento
                  type: integer
                alias:
                  description: Alias do meio de pagamento
                  type: string
                name:
                  description: Nome do meio de pagamento
                  type: string
                has_config:
                  description: Indica se há configuração disponível
                  type: boolean
                active_config:
                  description: Indica se a configuração está ativa
                  type: boolean
                is_credit_card:
                  description: Indica se é um cartão de crédito
                  type: boolean
                is_deposit:
                  description: Indica se é um pagamento por depósito
                  type: boolean
                is_billet:
                  description: Indica se é um boleto bancário
                  type: boolean
                is_pix:
                  description: Indica se é um pagamento via Pix
                  type: boolean
                is_pix_in_installments:
                  description: Indica se o Pix permite parcelamento
                  type: boolean
                is_wallet:
                  description: Indica se é um pagamento via carteira digital
                  type: boolean
                icon_url:
                  description: URL do ícone do meio de pagamento
                  type: string
                  format: uri
              type: object
          type: object
        metadata:
          description: Lista de metadados
          type: array
          items:
            properties:
              key:
                description: Chave do metadado
                type: string
                example: discount_highlight
              value:
                description: Valor do metadado
                type: string
                example: pix
            type: object
      type: object
    SimplePaginatorWithMeta:
      title: SimplePaginatorWithMeta
      description: Representa uma paginação com meta
      properties:
        meta:
          description: Metadados da resposta.
          properties:
            pagination:
              description: Dados de paginação do resultado.
              properties:
                total:
                  description: >-
                    Quantidade total de registros encontrados, considerando
                    todas as páginas.
                  type: integer
                  example: '10'
                count:
                  description: Quantidade de registros retornados na página atual.
                  type: integer
                  example: '30'
                per_page:
                  description: Quantidade máxima de registros por página.
                  type: integer
                  example: '10'
                current_page:
                  description: Número da página atual.
                  type: integer
                  example: '1'
                total_pages:
                  description: Quantidade total de páginas do resultado.
                  type: integer
                  example: '3'
                links:
                  description: Links de navegação entre as páginas do resultado.
                  properties:
                    previous:
                      description: >-
                        URL da página anterior, ausente quando a página atual é
                        a primeira.
                      type: string
                      example: ''
                    next:
                      description: >-
                        URL da próxima página, ausente quando a página atual é a
                        última.
                      type: string
                      example: ''
                  type: object
              type: object
          type: object
      type: object
    BaseTimestamp:
      description: >-
        Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário
        em que foi registrada.
      properties:
        date:
          description: Data e hora no formato YYYY-MM-DD H:MM:SS.
          type: string
          example: '2000-08-17 10:24:24'
        timezone_type:
          description: Número de representação do timezone.
          type: integer
          example: 3
        timezone:
          description: Fuso horário associado.
          type: string
          example: America/Sao_Paulo
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.