ChargeDynamicResponseDTO

Response for dynamic immediate charge creation

  • calendario
    Type: object · CalendarResponseDTO

    Calendar information in the charge response

    • criacao
      Type: string Format: date-time

      Creation timestamp of the charge.

    • expiracao
      Type: integer Format: int32

      Expiration time in seconds from creation.

  • chave
    Type: string

    Pix key of the receiver.

  • createdAt
    Type: string Format: date-time

    Creation timestamp.

  • devedor
    Type: object · DebtorDTO

    Debtor information (payer)

    • nome
      Type: string
      max length:  
      200
      required

      Name of the debtor (required when devedor is present)

    • cnpj
      Type: string

      CNPJ of the debtor (14 chars, [A-Z0-9])

    • cpf
      Type: string

      CPF of the debtor (11 digits)

  • id
    Type: string

    Unique identifier of the charge.

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

    Additional information list

    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[]

    Pix que liquidaram esta cobrança. Omitido quando não houve pagamento (Bacen: o campo não vem como array vazio).

    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) in plain text.

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

  • revisao
    Type: integer Format: int32

    Revision number of the charge.

  • solicitacaoPagador
    Type: string

    Optional message/request from 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 · AmountResponseDTO

    Amount information in the charge response

    • modalidadeAlteracao
      Type: integer Format: int32

      Change mode: 0 = fixed amount (default), 1 = payer can change amount

    • original
      Type: string

      Original amount in decimal format.

    • retirada
      Type: object · CashWithdrawalDTO

      Cash-out withdrawal (Pix Saque/Troco). Carries withdrawal XOR change.