ChargeDynamicResponseDTO

Response for dynamic immediate charge creation

  • additionalInfo
    Type: array object[] · AdditionalInfoDTO[]

    Additional information list

    Additional information for the payer

    • name
      Type: string
      max length:  
      50
      required

      Name/label of the additional information field.

    • value
      Type: string
      max length:  
      200
      required

      Value of the additional information field.

  • amount
    Type: object · AmountResponseDTO

    Amount information in the charge response

    • original
      Type: string

      Original amount in decimal format.

  • brCode
    Type: string

    Pix payload (BR Code) in plain text.

  • calendar
    Type: object · CalendarResponseDTO

    Calendar information in the charge response

    • createdAt
      Type: string Format: date-time

      Creation timestamp of the charge.

    • expiration
      Type: integer Format: int32

      Expiration time in seconds from creation.

  • createdAt
    Type: string Format: date-time

    Creation timestamp.

  • id
    Type: string

    Unique identifier of the charge.

  • key
    Type: string

    Pix key of the receiver.

  • location
    Type: object · LocationBindResponseDTO

    Location information in the charge response

    • id
      Type: string

      Unique identifier of the location.

    • url
      Type: string

      URL for accessing the dynamic QR Code.

  • payerRequest
    Type: string

    Optional message/request from the payer.

  • qrCodeImage
    Type: object · QrCodeImage

    QR Code image data. Returned only if 'emitImage=true' in the request.

    • base64
      Type: string

      Base64 encoded image data.

    • contentType
      Type: string

      Content type of the image.

  • revision
    Type: integer Format: int32

    Revision number of the charge.

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ACTIVE
    • COMPLETED
    • EXPIRED
    • REMOVED_BY_RECEIVER
    • REMOVED_BY_PSP
  • txid
    Type: string

    Transaction identifier.

  • type
    Type: string enum

    Type of QR Code

    values
    • STATIC
    • DYNAMIC
    • DYNAMIC_DUE_DATE
    • UNKNOWN