ChargeValidationResponseDTO

Charge validation response. Field layout mirrors cob (immediate charge), but the names and values are this API's own, not Bacen's: status is ACTIVE/COMPLETED/... rather than ATIVA/CONCLUIDA, and the nested objects are English throughout. Future extension: This format will support cobv (dynamic-due-date) with additional calendar/amount fields.

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

    Additional information list

    Additional information item

    • name
      Type: string

      Name/key of the additional info

    • value
      Type: string

      Value of the additional info

  • amount
    Type: object · ValidationAmountDTO

    Amount information of a validated charge

    • cashWithdrawal
      Type: object · ValidationCashWithdrawalDTO

      Cash-out withdrawal (Pix Saque/Troco) of a validated charge

    • changeMode
      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 · ValidationCalendarDTO

    Calendar information of a validated charge

    • createdAt
      Type: string Format: date-time

      Creation timestamp.

    • dueDate
      Type: string Format: date

      Due date of a due-date charge (cobv). Null for an immediate charge (cob), whose calendar is creation plus expiration and which has no due date.

    • expiration
      Type: integer Format: int32

      Expiration in seconds from creation.

    • validAfterDueDays
      Type: integer Format: int32

      Days after the due date during which a cobv still accepts payment. Null for a cob. A cobv is past its calendar validity when dueDate plus this is before today - the same rule expireDueDateChargesPastCalendarValidity applies.

  • 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 charge on Finaya's own (non-Bacen) surfaces

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

    Transaction identifier (txid).