> ## Documentation Index > Fetch the complete documentation index at: https://docs.pay.v4companyamaral.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar a trilha de auditoria da loja > Retorna as ações de escrita feitas na loja (painel e API), das mais recentes para as mais antigas. Todas as ações de criação, edição, exclusão, cancelamento, reembolso, login e cadastro são registradas automaticamente, com quem fez, a origem e o IP. ## OpenAPI ````yaml /openapi.yaml get /audit openapi: 3.1.0 info: title: V4Pay API version: 2.0.0 description: > API do gateway de pagamentos V4Pay: autenticação, clientes, cobranças, cupons e emissão de Pix — cada lojista tem uma conta de recebimento no CNPJ dele, e a cobrança leva um split com a taxa do V4 Pay. Todas as rotas protegidas usam token JWT — o usuário é identificado pelo token, nunca por `user_id` no corpo da requisição. servers: - url: https://v4pay-api.vercel.app description: Produção. - url: http://localhost:3000 description: Ambiente local de desenvolvimento. security: [] tags: - name: Pix description: Emitir e consultar cobranças Pix — o coração da API. - name: Cobranças description: Registro direto de cobranças e a listagem do histórico da loja. - name: Clientes description: Cadastro de pagadores para reutilizar nas cobranças. - name: Links de pagamento description: URLs públicas reutilizáveis que abrem o checkout com o valor definido. - name: Checkout (público) description: >- As rotas que a página de pagamento usa — sem autenticação, o pagador não tem conta. - name: Produtos description: Catálogo da loja; um produto pode virar cobrança ou link. - name: Cupons description: Descontos aplicados no checkout e na emissão por produto. - name: Assinaturas description: Cobrança recorrente, gerada por um cron diário. - name: Webhooks (endpoints) description: >- As URLs do seu servidor que recebem os eventos da loja, com assinatura HMAC. - name: Chaves de API description: Credenciais de integração (v4pay_test_ / v4pay_live_), revogáveis. - name: Conta de recebimento description: Cadastro da empresa e a conta que recebe — vale no modo subconta. - name: Aprovação de produção description: >- O fluxo para liberar a operação em produção — dados da empresa, documentos e análise da equipe. - name: Saques description: >- Pedidos de saque do saldo — suspensos no modo conta única (REPASSE_MANUAL). - name: Membros da loja description: Convites e papéis de quem opera a loja junto com o dono. - name: Conta (auth) description: Cadastro, login, perfil e a troca de ambiente da sessão. - name: Auditoria description: Trilha das ações feitas na loja, com quem fez e de onde. - name: Sistema description: Saúde da API. - name: Interno description: >- USO INTERNO DO PAINEL — documentado por transparência, não para integração: pode mudar sem aviso (Roadmap, aprovações da equipe, cron, login com Google, onboarding). paths: /audit: get: tags: - Auditoria summary: Listar a trilha de auditoria da loja description: > Retorna as ações de escrita feitas na loja (painel e API), das mais recentes para as mais antigas. Todas as ações de criação, edição, exclusão, cancelamento, reembolso, login e cadastro são registradas automaticamente, com quem fez, a origem e o IP. parameters: - in: query name: action schema: type: string enum: - create - update - delete - cancel - refund - charge - test - login - register description: Filtra por tipo de ação. - in: query name: resource schema: type: string enum: - charge - customer - coupon - product - subscription - payment_link - withdrawal - api_key - webhook_endpoint - member - itau_webhook - profile - auth description: Filtra por recurso afetado. - in: query name: origin schema: type: string enum: - painel - api description: Filtra pela origem da ação. - in: query name: actor schema: type: string format: uuid description: Filtra pelo id do usuário que fez a ação. - in: query name: limit schema: type: integer default: 300 maximum: 500 description: Máximo de registros retornados. responses: '200': description: Registros de auditoria. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AuditLog' '401': $ref: '#/components/responses/Unauthorized' security: - bearerAuth: [] components: schemas: AuditLog: type: object description: Um registro da trilha de auditoria da loja. properties: id: type: string format: uuid actor_user_id: type: - string - 'null' format: uuid description: Id de quem fez a ação (dono ou membro); null para chave de API. actor_email: type: - string - 'null' description: E-mail de quem fez a ação; null para chave de API. example: maria@empresa.com.br action: type: string enum: - create - update - delete - cancel - refund - charge - test - login - register example: create resource: type: string description: Recurso afetado. example: product resource_id: type: - string - 'null' description: Id do recurso afetado. target: type: - string - 'null' description: Descrição legível do alvo (nome do produto, e-mail do membro...). example: Produto Premium origin: type: string enum: - painel - api description: De onde a ação partiu. ip: type: - string - 'null' description: IP de quem fez a requisição. example: 187.11.42.10 created_at: type: string format: date-time ErrorAuth: type: object description: > Segundo formato de erro, usado só pelo middleware de autenticação (token ausente, inválido ou chave revogada). Repare que aqui `error` é uma string, não um objeto. properties: error: type: string example: Token JWT ou chave de API ausente responses: Unauthorized: description: Não autenticado. Repare no formato — `error` é string neste caso. content: application/json: schema: $ref: '#/components/schemas/ErrorAuth' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token JWT obtido em `/auth/login`, enviado no cabeçalho `Authorization` no formato `Bearer `. ````