ChargeDueDateRequestDTO

Request to create a dynamic charge with due date (COBV)

  • calendario
    Type: object · CalendarDueDateRequestDTO
    required

    Calendar settings for charge with due date (COBV)

    • dataDeVencimento
      Type: string Format: date
      required

      Due date for the charge (YYYY-MM-DD). Must be greater than or equal to creation date.

    • validadeAposVencimento
      Type: integer Format: int32
      min:  
      0

      Number of days the charge remains valid after due date. If 0, payment is not allowed after due date. Default is 30 days (Bacen v2.9.0).

  • chave
    Type: string
    min length:  
    1
    required

    Pix key of the receiver. EVP, email, CPF/CNPJ or phone in E.164 format (+55...).

  • devedor
    Type: object · DebtorRequestDTO
    required

    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)

  • valor
    Type: object · AmountDueDateRequestDTO
    required

    Amount configuration for charge with due date (COBV)

    • original
      Type: string
      min length:  
      1
      required

      Original amount in decimal format with exactly 2 decimal places

    • 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

  • emitImage
    Type: boolean

    If true, returns the PNG image (base64) in the response

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

    Additional information list for the payer

    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.

  • loc
    Type: object · LocationBindRequestDTO

    Location reference for binding to a charge

    • id
      Type: string Format: uuid
      required

      Unique identifier of the location to bind.

  • locationId
    Type: string Format: uuid
    deprecated

    DEPRECADO — use loc: { "id": ... }. A API Pix 2.9.0 define loc para a cobv, como ja faz a cob, e e loc que a resposta desta cobranca devolve. Aceito apenas para nao quebrar quem ja integrou; sera removido.

  • recebedor
    Type: object · CobvReceiverRequestDTO

    Receiver (recebedor) information for a cobv

    • cep
      Type: string
      min length:  
      1
      required

      Postal code (CEP) - 8 digits without hyphen

    • cidade
      Type: string
      max length:  
      200
      required

      City name

    • logradouro
      Type: string
      max length:  
      200
      required

      Street name and number

    • nome
      Type: string
      max length:  
      200
      required

      Receiver name

    • taxId
      Type: string
      min length:  
      1
      required

      Receiver tax ID (CPF/CNPJ)

    • uf
      Type: string
      min length:  
      1
      required

      State code (2 uppercase letters)

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Optional message/request for the payer