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

      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

  • cashWithdrawal
    Type: object · CashWithdrawalInfo

    Decoded cash-out withdrawal (Pix Saque/Troco) breakdown

    • agentModality
      Type: string enum

      Withdrawal agent modality (Bacen modalidadeAgente)

      values
      • AGTEC
      • AGTOT
      • AGPSS
    • cashAmount
      Type: string

      Cash-out withdrawal/change amount

    • cashierIspb
      Type: string

      ISPB of the withdrawal service facilitator (FSS)

    • changeMode
      Type: integer Format: int32

      Change mode: 0 = fixed, 1 = payer can change

    • type
      Type: string enum

      Withdrawal kind

      values
      • SAQUE
      • TROCO
  • cobvFinalAmountBreakdown
    Type: object · CobvFinalAmountBreakdown

    Discriminated COBV final amount for payer transparency

    • appliedDiscount
      Type: string

      Early-payment discount applied

    • appliedFine
      Type: string

      Late-payment fine applied

    • appliedInterest
      Type: string

      Late-payment interest applied

    • appliedRebate
      Type: string

      Rebate (abatimento) applied

    • finalValue
      Type: string

      Final amount

    • municipalityCode
      Type: string

      IBGE municipality code informed by the payer

    • originalValue
      Type: string

      Original charge amount

    • paymentDate
      Type: string

      DPP used for the calculation

  • 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

  • recurrence
    Type: object · RecurrenceInfo

    Pix Automático recurrence terms

    • contract
      Type: string

      Contract the recurrence is bound to

    • debtorCnpj
      Type: string

      Debtor CNPJ

    • debtorCpf
      Type: string

      Debtor CPF

    • debtorName
      Type: string

      Debtor name as stated in the recurrence

    • endDate
      Type: string

      Last date payments may occur (absent on open-ended recurrences)

    • object
      Type: string

      Identifier of the bound object

    • periodicity
      Type: string

      How often the charge repeats

    • receiverCnpj
      Type: string

      Receiver CNPJ

    • receiverIspb
      Type: string

      ISPB of the receiver participant

    • receiverMinimumValue
      Type: string

      Smallest amount the receiver accepts

    • receiverName
      Type: string

      Receiver name

    • recurrenceId
      Type: string

      Recurrence identifier

    • retryPolicy
      Type: string

      Retry policy after a missed due date

    • startDate
      Type: string

      Estimated date of the first payment

    • status
      Type: string

      Current recurrence status, the latest entry of the status history

    • value
      Type: string

      Recurrence amount

  • revision
    Type: integer Format: int32

    Charge revision number

  • status
    Type: string enum

    Status of a charge on Finaya's own (non-Bacen) surfaces

    values
    • ACTIVE
    • COMPLETED
    • 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
    • COMPOSITE
    • UNKNOWN
  • value
    Type: string

    Total amount the payer pays, in decimal format (null if not specified). For Pix Saque this is the withdrawal amount; for Pix Troco it is the purchase plus the change; otherwise it is the original amount.