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

# Criar Transação

> Cria uma nova transação de pagamento



## OpenAPI

````yaml POST /api/v1/transactions
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/v1/transactions:
    post:
      tags:
        - Transações
      summary: Criar transação
      description: Cria uma nova transação de pagamento
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransactionRequest'
      responses:
        '201':
          description: Transação criada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  transaction:
                    $ref: '#/components/schemas/Transaction'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CreateTransactionRequest:
      type: object
      required:
        - product
        - amountCents
        - clientName
        - clientEmail
        - clientDocument
      properties:
        product:
          type: string
          maxLength: 255
          description: Nome ou descrição do produto/serviço
        amountCents:
          type: integer
          minimum: 1
          maximum: 100000000
          description: 'Valor em centavos. Exemplo: 9900 = R$ 99,00'
        clientName:
          type: string
          maxLength: 255
          description: Nome completo do cliente
        clientEmail:
          type: string
          format: email
          maxLength: 255
          description: Email do cliente
        clientPhone:
          type: string
          maxLength: 20
          nullable: true
          description: 'Telefone do cliente. Exemplo: 11999999999'
        clientDocument:
          type: string
          minLength: 11
          maxLength: 20
          description: CPF ou CNPJ do cliente (apenas números). Mínimo 11 dígitos.
        paymentMethod:
          type: string
          enum:
            - PIX
            - CARD
            - BOLETO
          default: PIX
          description: Método de pagamento
        paymentLinkId:
          type: string
          format: uuid
          description: ID do link de pagamento associado (opcional)
        installments:
          type: integer
          minimum: 1
          maximum: 12
          description: Número de parcelas (apenas cartão de crédito)
        dueDate:
          type: string
          format: date-time
          description: Data de vencimento (opcional)
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Dados adicionais personalizados. Exemplo: { "orderId": "4836572",
            "source": "checkout-parceiro" }
        trackingParams:
          type: object
          description: Parâmetros de rastreamento UTM
          properties:
            utm_source:
              type: string
              nullable: true
            utm_medium:
              type: string
              nullable: true
            utm_campaign:
              type: string
              nullable: true
            utm_content:
              type: string
              nullable: true
            utm_term:
              type: string
              nullable: true
            src:
              type: string
              nullable: true
            sck:
              type: string
              nullable: true
        postbackUrl:
          type: string
          format: uri
          nullable: true
          description: >-
            URL para receber notificação de mudança de status desta transação
            via HTTP POST. Enviado quando o status muda para COMPLETED ou
            FAILED. Inclui header X-Webhook-Signature com assinatura HMAC-SHA256
            para validação.
    Transaction:
      type: object
      properties:
        id:
          type: string
          format: uuid
        displayId:
          type: string
          nullable: true
        product:
          type: string
          nullable: true
        amountCents:
          type: integer
          nullable: true
        status:
          type: string
        paymentMethod:
          type: string
        client:
          type: object
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        trackingParams:
          type: object
          nullable: true
          description: Parâmetros de rastreamento (UTMs, etc)
  responses:
    BadRequest:
      description: Requisição inválida
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              timestamp:
                type: string
                format: date-time
              path:
                type: string
              errors:
                type: array
                items:
                  type: object
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    Forbidden:
      description: Acesso negado - Permissão insuficiente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````