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

  • calendario
    Type: object · CalendarDueDatePatchDTO

    Calendário da revisão da cobrança com vencimento

    • dataDeVencimento
      Type: string Format: date

      Nova data de vencimento (YYYY-MM-DD)

    • validadeAposVencimento
      Type: integer Format: int32

      Dias em que a cobrança segue pagável após o vencimento

  • devedor
    Type: object · DebtorRequestDTO

    Debtor (payer) information

    • nome
      Type: string
      max length:  
      200
      required

      Debtor name (max 200)

    • cep
      Type: string
      max length:  
      8

      Debtor postal code (CEP)

    • cidade
      Type: string
      max length:  
      200

      Debtor city

    • cnpj
      Type: string

      Debtor CNPJ (14 chars, [A-Z0-9])

    • cpf
      Type: string

      Debtor CPF (11 digits)

    • email
      Type: string
      max length:  
      200

      Debtor email

    • logradouro
      Type: string
      max length:  
      200

      Debtor street address

    • uf
      Type: string
      max length:  
      2

      Debtor state (UF)

  • emitImage
    Type: boolean

    Se true, devolve o PNG do QR Code em base64 (extensão Finaya)

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

    Substitui a lista de informações adicionais por inteiro quando enviada

    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.

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Texto a ser apresentado ao pagador

  • status
    enum
    const:  
    REMOVIDA_PELO_USUARIO_RECEBEDOR

    Status of a dynamic charge

    values
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
  • valor
    Type: object · AmountDueDatePatchDTO

    Valor e encargos da revisão da cobrança com vencimento

    • abatimento
      Type: object · AbatementDTO

      Abatement configuration for charge with due date

    • desconto
      Type: object · DiscountDTO

      Discount configuration for charge with due date

    • juros
      Type: object · InterestDTO

      Interest configuration for charge with due date

    • multa
      Type: object · FineDTO

      Fine configuration for charge with due date

    • original
      Type: string

      Novo valor original