ChargeDueDateResponseDTO

Response for dynamic charge with due date (COBV) creation

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

    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.

  • amount
    Type: object · AmountDueDateResponseDTO

    Amount information for charge with due date (COBV) response

    • abatement
      Type: object · AbatementDTO

      Abatement configuration for charge with due date

    • discount
      Type: object · DiscountDTO

      Discount configuration for charge with due date

    • fine
      Type: object · FineDTO

      Fine configuration for charge with due date

    • interest
      Type: object · InterestDTO

      Interest configuration for charge with due date

    • original
      Type: string

      Original amount in decimal format

  • brCode
    Type: string

    Pix payload (BR Code) containing only the Location URL

  • calendar
    Type: object · CalendarDueDateResponseDTO

    Calendar information for charge with due date (COBV) response

    • createdAt
      Type: string Format: date-time

      Creation timestamp of the charge

    • dueDate
      Type: string Format: date

      Due date for the charge (YYYY-MM-DD)

    • validAfterDueDays
      Type: integer Format: int32

      Number of days the charge remains valid after due date

  • createdAt
    Type: string Format: date-time

    Creation timestamp

  • id
    Type: string

    Unique identifier of the charge

  • key
    Type: string

    Pix key of the receiver

  • location
    Type: object · LocationBindResponseDTO

    Location information in the charge response

    • id
      Type: string

      Unique identifier of the location.

    • url
      Type: string

      URL for accessing the dynamic QR Code.

  • merchant
    Type: object · MerchantDataResponseDTO

    Merchant (receiver) information in the response

    • city
      Type: string

      Merchant city

    • name
      Type: string

      Merchant name

    • taxId
      Type: string

      Merchant tax ID (CPF/CNPJ)

  • payerRequest
    Type: string

    Optional message/request for the payer

  • qrCodeImage
    Type: object · QrCodeImage

    QR Code image data. Returned only if 'emitImage=true' in the request.

    • base64
      Type: string

      Base64 encoded image data.

    • contentType
      Type: string

      Content type of the image.

  • revision
    Type: integer Format: int32

    Revision number of the charge. Starts at 0 on creation.

  • status
    Type: string enum

    Status of a dynamic charge

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

    Transaction identifier

  • type
    Type: string enum

    Type of QR Code

    values
    • STATIC
    • DYNAMIC
    • DYNAMIC_DUE_DATE
    • UNKNOWN