ChargeDynamicRequestDTO

Request to create a dynamic immediate charge with location binding

  • calendario
    Type: object · CalendarRequestDTO
    required

    Calendar settings for the charge expiration

    • expiracao
      Type: integer Format: int32
      min:  
      1
      required

      Expiration time in seconds from creation (no max limit as per Bacen API Pix v2.9.0).

  • chave
    Type: string
    min length:  
    1
    required

    Pix key of the receiver. EVP, email, CPF/CNPJ or phone in E.164 format (+55...).

  • valor
    Type: object · AmountRequestDTO
    required

    Amount information for the charge

    • original
      Type: string
      min length:  
      1      Pattern: ^\d+\.\d{2}$
      required

      Original amount in decimal format with exactly 2 decimal places.

    • modalidadeAlteracao
      Type: integer Format: int32enum

      Change mode: 0 = fixed amount (default), 1 = payer can change amount

      values
      • 0
      • 1
  • devedor
    Type: object · DebtorDTO

    Debtor information (payer)

    • cnpj
      Type: string Pattern: ^\d{14}$

      CNPJ of the debtor (14 digits)

    • cpf
      Type: string Pattern: ^\d{11}$

      CPF of the debtor (11 digits)

    • nome
      Type: string
      min length:  
      1
      max length:  
      200

      Name of the debtor

  • emitImage
    Type: boolean

    If true, also returns the PNG image (base64).

  • infoAdicionais
    Type: array object[] · AdditionalInfoDTO[] …50

    Additional information list for the payer

    Additional information for the payer

    • nome
      Type: string
      max length:  
      50
      required

      Name/label of the additional information field.

    • valor
      Type: string
      max length:  
      200
      required

      Value of the additional information field.

  • loc
    Type: object · LocationBindRequestDTO

    Location reference for binding to a charge

    • id
      Type: string Format: uuid
      required

      Unique identifier of the location to bind.

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Optional message/request from the payer.