ChargeDueDateResponseDTO

Response for dynamic charge with due date (COBV) creation

  • calendario
    Type: object · CalendarDueDateResponseDTO

    Calendar information for charge with due date (COBV) response

    • criacao
      Type: string Format: date-time

      Creation timestamp of the charge

    • dataDeVencimento
      Type: string Format: date

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

    • validadeAposVencimento
      Type: integer Format: int32

      Number of days the charge remains valid after due date

  • chave
    Type: string

    Pix key of the receiver

  • createdAt
    Type: string Format: date-time

    Creation timestamp

  • devedor
    Type: object · DebtorResponseDTO

    Debtor (payer) information in the response

    • cep
      Type: string

      Debtor postal code (CEP)

    • cidade
      Type: string

      Debtor city

    • cnpj
      Type: string

      Debtor CNPJ

    • cpf
      Type: string

      Debtor CPF

    • email
      Type: string

      Debtor email

    • logradouro
      Type: string

      Debtor street address

    • nome
      Type: string

      Debtor name

    • uf
      Type: string

      Debtor state (UF)

  • id
    Type: string

    Unique identifier of the charge

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

    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 · LocationBindResponseDTO

    Location do payload vinculada à cobrança

    • criacao
      Type: string Format: date-time

      Data e hora de criação da location (RFC 3339)

    • id
      Type: string

      Identificador da location

    • location
      Type: string

      URL do payload, a mesma que viaja no BR Code

    • tipoCob
      Type: string enum

      Type of charge bound to the location (Bacen tipoCob)

      values
      • cob
      • cobv
  • location
    Type: string

    URL do payload — o mesmo valor de loc.location, que a norma repete na raiz porque é ela que viaja no BR Code

  • pix
    Type: array object[] · PixDTO[]

    List of Pix payments received for this charge. Only present when at least one payment has been made.

    Pix recebido (Bacen)

    • chave
      Type: string

      Chave Pix do recebedor

    • componentesValor
      Type: object · ComponentesValorDTO

      Componentes do valor do Pix recebido (Bacen)

    • devolucoes
      Type: array object[] · RefundDTO[]

      Devoluções associadas ao Pix

      Devolução de um Pix recebido (Bacen)

    • endToEndId
      Type: string

      EndToEndId do Pix recebido

    • horario
      Type: string Format: date-time

      Horário de liquidação do Pix

    • infoPagador
      Type: string

      Informação livre do pagador

    • txid
      Type: string

      Txid da cobrança associada, quando houver

    • valor
      Type: string

      Valor do Pix no formato Bacen

  • pixCopiaECola
    Type: string

    Pix payload (BR Code) containing only the Location URL

  • 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.

  • recebedor
    Type: object · CobvReceiverResponseDTO

    Receiver (recebedor) information in the cobv response

    • cep
      Type: string

      Postal code (CEP) - 8 digits without hyphen

    • cidade
      Type: string

      City name

    • logradouro
      Type: string

      Street name and number

    • nome
      Type: string

      Receiver name

    • taxId
      Type: string

      Receiver tax ID (CPF/CNPJ)

    • uf
      Type: string

      State code (2 uppercase letters)

  • revisao
    Type: integer Format: int32

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

  • solicitacaoPagador
    Type: string

    Optional message/request for the payer

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
  • txid
    Type: string

    Transaction identifier

  • type
    Type: string enum

    Type of QR Code

    values
    • STATIC
    • DYNAMIC
    • DYNAMIC_DUE_DATE
    • COMPOSITE
    • UNKNOWN
  • valor
    Type: object · AmountDueDateResponseDTO

    Amount information for charge with due date (COBV) response

    • 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

      Original amount in decimal format