ApiResponse

Formato padrão de resposta da API

  • data

    Dados da resposta (estrutura varia conforme o endpoint)

  • error
    Type: object · ErrorResponse

    Objeto de erro (apenas quando success=false)

    • code
      Type: string

      Stable machine-readable error code (e.g. VALIDATION_ERROR, AUTHENTICATION_ERROR, DUPLICATE_WITHDRAWAL_RISK)

    • details

      Optional structured payload: validation field list, retryAfter seconds, existingWithdrawalId for duplicate withdrawal risk, etc. Shape varies by code.

    • integrationError

      Optional structured integration hint (transactions). Same additive rules as details.

    • message
      Type: string

      Human-readable message without acquirer or PSP identifiers

    • path
      Type: string

      Request path that produced the error

    • timestamp
      Type: string Format: date-time

      When the error was materialized (ISO 8601)

    • traceId
      Type: string

      Correlation / trace identifier for support and logs

  • meta
    Type: object
    • requestId
      Type: string

      ID único da requisição para rastreamento (formato: req_${timestamp}_${random})

    • timestamp
      Type: string Format: date-time

      Timestamp da resposta em horário de Brasília (America/Sao_Paulo), contrato ISO com sufixo Z

    • timezone
      Type: string

      IANA timezone dos timestamps públicos (America/Sao_Paulo)

    • version
      Type: string

      Versão da API (ex: v1, 1.0)

  • success
    Type: boolean

    Indica se a requisição foi bem-sucedida