TransactionApiResponse

  • amount
    Type: integer

    Valor em centavos

  • boletoUrl
    Type: string Format: uri

    URL do boleto - apenas para Boleto

  • companyId
    Type: string

    ID da empresa

  • createdAt
    Type: string Format: date-time

    Data de criação em horário de Brasília (America/Sao_Paulo), contrato ISO com sufixo Z

  • currency
    enum
    const:  
    BRL

    Moeda (sempre BRL)

    values
    • BRL
  • customer
    Type: object · CustomerInfo

    Dados do cliente

    • document
      Type: object
      required
    • email
      Type: string Format: email
      required

      Email do cliente

    • name
      Type: string
      required

      Nome completo do cliente

    • phone
      Type: string
      required

      Telefone do cliente (formato: DDD + número, ex: 11999999999)

  • id
    Type: string

    ID único da transação

  • paymentMethod
    Type: string enum

    Método de pagamento

    values
    • pix
    • credit_card
    • boleto
  • pixQrCode
    Type: string

    Código PIX (copy-paste) - apenas para PIX

  • pixQrCodeImage
    Type: string Format: uri

    URL da imagem do QR Code PIX - apenas para PIX

  • splits
    Type: array object[] · TransactionSplitResponse[]

    Present only when the transaction was created with internal split instructions.

    • amount
      Type: integer

      Integer numbers.

    • percentageBps
      Type: integer

      Integer numbers.

    • recipientId
      Type: string Format: uuid
    • reference
      Type: string
    • type
      Type: string enum
      values
      • FIXED
      • PERCENTAGE
  • status
    Type: string enum

    Status da transação (UPPERCASE)

    values
    • PENDING
    • PROCESSING
    • PAID
    • FAILED
    • CANCELED
    • BLOCKED
    • REFUNDED
    • PRE_CHARGEBACK
    • CHARGEBACK