CreateTransactionDto

  • amount
    Type: integer
    min:  
    100
    required

    Valor em centavos (ex: R$ 100,00 = 10000). Valor mínimo: R$ 1,00 (100 centavos)

  • customer
    Type: object · CustomerInfo
    required
    • 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)

  • items
    Type: array object[] · TransactionItem[] 1…
    required

    Lista de itens da transação

    • quantity
      Type: integer
      min:  
      1
      required

      Quantidade do item

    • tangible
      Type: boolean
      required

      Se o produto é físico (true) ou digital (false)

    • title
      Type: string
      required

      Nome/título do produto ou serviço

    • unitPrice
      Type: integer
      min:  
      1
      required

      Preço unitário em centavos

  • paymentMethod
    Type: string enum
    required

    Método de pagamento

    values
    • pix
    • credit_card
    • boleto
  • delivery
    Type: object · DeliveryInfo

    Informações de entrega (opcional). Se o objeto vier incompleto, será ignorado.

    • city
      Type: string

      Cidade

    • neighborhood
      Type: string

      Bairro

    • number
      Type: string

      Número

    • state
      Type: string

      Estado (UF)

    • street
      Type: string

      Rua/Logradouro

    • zipcode
      Type: string

      CEP (apenas dígitos)

  • installments
    Type: integer
    min:  
    1
    max:  
    12

    Número de parcelas (apenas para cartão de crédito, máximo 12x)

  • postbackUrl
    Type: string Format: uri

    URL HTTPS adicional para receber webhooks de transação (postback). Envio aditivo aos webhooks configurados no dashboard. URLs inválidas, locais ou privadas são bloqueadas.

  • splits
    Type: array object[] · TransactionSplitInput[] …20

    Optional internal split instructions. Available for PIX transactions when internal splits are enabled; instructions are processed by PodPay and are not forwarded to acquirers.

    • recipientId
      Type: string Format: uuid
      required

      Destination company id.

    • type
      Type: string enum
      required

      Split calculation mode.

      values
      • FIXED
      • PERCENTAGE
    • amount
      Type: integer
      min:  
      1

      Fixed amount in cents. Required when type is FIXED.

    • percentageBps
      Type: integer
      min:  
      1
      max:  
      7000

      Percentage in basis points. Required when type is PERCENTAGE; 100 basis points = 1%.

    • reference
      Type: string
      max length:  
      100

      Optional merchant reference for the split recipient.