QrCodeDecodeResponseDTO

Response DTO with decoded QR Code information

  • additionalInfo
    Type: string

    Additional information from the QR Code

  • additionalInfoList
    Type: array object[] · AdditionalInfoItem[]

    Additional info items list

    Additional information item

    • name
      Type: string

      Name/key of the additional info

    • value
      Type: string

      Value of the additional info

  • calendar
    Type: object · CalendarInfo

    Calendar information for dynamic charges

    • createdAt
      Type: string Format: date-time

      Creation timestamp

    • dueDate
      Type: string Format: date-time

      Due date for cobv (charge with due date)

    • expiration
      Type: integer Format: int32

      Expiration in seconds from creation

    • expiresAt
      Type: string Format: date-time

      Expiration timestamp

  • cobvFinalAmountBreakdown
    Type: object · CobvFinalAmountBreakdown

    Discriminated COBV final amount for payer transparency

    • abatimentoAplicado
      Type: string

      Abatimento applied

    • codMun
      Type: string

      IBGE municipality code informed by the payer

    • dataPagamento
      Type: string

      DPP used for the calculation

    • descontoAplicado
      Type: string

      Desconto por antecipação

    • jurosAplicado
      Type: string

      Juros por atraso

    • multaAplicada
      Type: string

      Multa por atraso

    • valorFinal
      Type: string

      Final amount

    • valorOriginal
      Type: string

      Original charge amount

  • debtor
    Type: object · DebtorInfo

    Debtor (payer) information

    • cnpj
      Type: string

      CNPJ of the debtor

    • cpf
      Type: string

      CPF of the debtor

    • name
      Type: string

      Name of the debtor

  • emv
    Type: string

    EMV payload extracted from the QR Code.

  • endToEndId
    Type: string

    End-to-end identifier associated with the PIX key (from keys service lookup)

  • ispb
    Type: string

    ISPB of the institution that owns the charge

  • key
    Type: string

    PIX key extracted from the payload (null for dynamic QR codes)

  • locationUrl
    Type: string

    Location URL for dynamic QR codes (null for static)

  • merchant
    Type: object · MerchantDataResponseDTO

    Merchant (receiver) information in the response

    • city
      Type: string

      Merchant city

    • name
      Type: string

      Merchant name

    • taxId
      Type: string

      Merchant tax ID (CPF/CNPJ)

  • receiver
    Type: object · ReceiverInfo

    Receiver (creditor) information

    • accountBranch
      Type: string

      Branch number

    • accountIspb
      Type: string

      Institution ISPB (from EMV additional data or key lookup)

    • accountNumber
      Type: string

      Account number

    • accountType
      Type: string

      Account type (e.g. CACC)

    • name
      Type: string

      Holder name (creditor), not the merchant trade name

    • taxId
      Type: string

      Holder tax id (CPF or CNPJ digits only), aligned with holder_tax_id

    • tradeName
      Type: string

      Trade name

    • uf
      Type: string

      UF/State

  • revision
    Type: integer Format: int32

    Charge revision number

  • status
    Type: string enum

    Status of a dynamic charge

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

    Transaction ID (txid)

  • type
    Type: string enum

    Type of QR Code

    values
    • STATIC
    • DYNAMIC
    • DYNAMIC_DUE_DATE
    • UNKNOWN
  • value
    Type: string

    Transaction amount in decimal format (null if not specified)