ChargeValidationResponseDTO

Pix-like response for charge validation. Compatible with cob (immediate charge) format. Future extension: This format will support cobv (dynamic-due-date) with additional calendar/amount fields.

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

    Additional information list

    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.

  • amount
    Type: object · AmountResponseDTO

    Amount information in the charge response

    • modalidadeAlteracao
      Type: integer Format: int32

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

    • original
      Type: string

      Original amount in decimal format.

  • calendar
    Type: object · CalendarResponseDTO

    Calendar information in the charge response

    • criacao
      Type: string Format: date-time

      Creation timestamp of the charge.

    • expiracao
      Type: integer Format: int32

      Expiration time in seconds from creation.

  • key
    Type: string

    Pix key of the receiver.

  • location
    Type: object · LocationValidationResponseDTO

    Location information in the charge validation 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.

  • revision
    Type: integer Format: int32

    Revision number of the charge.

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
  • txid
    Type: string

    Transaction identifier (txid).