CobvBatchItemPatchDTO

Item de revisão de um lote COBV: txid existente + campos revisados

  • txid
    Type: string
    min length:  
    1
    required

    Transaction id de uma cobrança já pertencente ao lote

  • abatement
    Type: object · AbatementDTO

    Abatement configuration for charge with due date

    • modalidade
      Type: string enum
      required

      Mode for calculating abatement on a charge with due date (Bacen API Pix v2.9.0 spec)

      values
      • 1
      • 2
    • valorPerc
      Type: string Pattern: ^\d+\.\d{2}$

      Abatement value (required when the abatimento object is present). For FIXED: absolute value, for PERCENT: percentage value

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

    Replaces the full additional information list when sent

    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.

  • discount
    Type: object · DiscountDTO

    Discount configuration for charge with due date

    • modalidade
      Type: string enum
      required

      Mode for calculating discount on a charge with due date (Bacen API Pix v2.9.0 spec)

      values
      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
    • descontoDataFixa
      Type: array object[] · FixedDateDiscountDTO[] …3

      List of fixed date discounts (required when mode = FIXED_DATE, max 3 entries)

      Fixed date discount entry

    • valorPerc
      Type: string Pattern: ^\d+\.\d{2}$

      Discount value (required when mode = DAILY). Represents daily discount rate.

  • dueDate
    Type: string Format: date

    New due date (YYYY-MM-DD)

  • emitImage
    Type: boolean

    If true, includes base64 PNG in the response

  • fine
    Type: object · FineDTO

    Fine configuration for charge with due date

    • modalidade
      Type: string enum
      required

      Mode for calculating fine on a charge with due date (Bacen API Pix v2.9.0 spec)

      values
      • 1
      • 2
    • valorPerc
      Type: string Pattern: ^\d+\.\d{2}$

      Fine value (required when the multa object is present). For FIXED: absolute value, for PERCENT: percentage value

  • interest
    Type: object · InterestDTO

    Interest configuration for charge with due date

    • modalidade
      Type: string enum
      required

      Mode for calculating interest on a charge with due date (Bacen API Pix v2.9.0 spec)

      values
      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
    • valorPerc
      Type: string Pattern: ^\d+\.\d{2}$

      Interest rate value (required when mode = DAILY). Represents daily interest rate.

  • original
    Type: string Pattern: ^\d+\.\d{2}$

    New original amount (replaces stored value)

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVED_BY_RECEIVER
  • validAfterDueDays
    Type: integer Format: int32

    Days the charge remains valid after the due date