ChargeDueDateRequestDTO

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

  • amount
    Type: object · AmountDueDateRequestDTO
    required

    Amount configuration for charge with due date (COBV)

    • abatement
      Type: object · AbatementDTO
      required

      Abatement configuration for charge with due date

    • discount
      Type: object · DiscountDTO
      required

      Discount configuration for charge with due date

    • fine
      Type: object · FineDTO
      required

      Fine configuration for charge with due date

    • interest
      Type: object · InterestDTO
      required

      Interest configuration for charge with due date

    • original
      Type: string
      min length:  
      1      Pattern: ^\d+\.\d{2}$
      required

      Original amount in decimal format with exactly 2 decimal places

  • calendar
    Type: object · CalendarDueDateRequestDTO
    required

    Calendar settings for charge with due date (COBV)

    • dueDate
      Type: string Format: date
      required

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

    • validAfterDueDays
      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 (rule applied in phase 2). Default is 0.

    • validAfterDueDaysOrDefault
      Type: integer Format: int32

      Signed 32-bit integers (commonly used integer type).

  • locationId
    Type: string Format: uuid
    required

    Location ID to bind to this charge

  • merchant
    Type: object · MerchantDataRequestDTO
    required

    Merchant (receiver) information for EMV payload composition

    • city
      Type: string
      min length:  
      1
      required

      Merchant city (EMV ID 60).

    • name
      Type: string
      min length:  
      1
      required

      Merchant name (EMV ID 59).

    • taxId
      Type: string
      min length:  
      1
      required

      Merchant tax ID (CPF/CNPJ).

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

    Additional information list for the payer

    Additional information for the payer

    • name
      Type: string
      max length:  
      50
      required

      Name/label of the additional information field.

    • value
      Type: string
      max length:  
      200
      required

      Value of the additional information field.

  • emitImage
    Type: boolean

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

  • key
    Type: string

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

  • payerRequest
    Type: string
    max length:  
    140

    Optional message/request for the payer