ChargeDynamicListResponseDTO

Resultado da consulta de cobranças imediatas (Bacen)

  • cobs
    Type: array object[] · ChargeDynamicResponseDTO[]

    Cobranças encontradas

    Response for dynamic immediate charge creation

    • calendario
      Type: object · CalendarResponseDTO

      Calendar information in the charge response

    • chave
      Type: string

      Pix key of the receiver.

    • createdAt
      Type: string Format: date-time

      Creation timestamp.

    • devedor
      Type: object · DebtorDTO

      Debtor information (payer)

    • id
      Type: string

      Unique identifier of the charge.

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

      Additional information list

      Additional information for the payer

    • loc
      Type: object · LocationBindResponseDTO

      Location do payload vinculada à cobrança

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

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

    • 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

  • parametros
    Type: object · ChargeQueryParametersDTO

    Parâmetros utilizados na consulta de cobranças

    • cnpj
      Type: string

      Filtro por CNPJ do devedor, quando informado

    • cpf
      Type: string

      Filtro por CPF do devedor, quando informado

    • fim
      Type: string Format: date-time

      Instante final do filtro (criação da cobrança), RFC 3339

    • inicio
      Type: string Format: date-time

      Instante inicial do filtro (criação da cobrança), RFC 3339

    • locationPresente
      Type: boolean

      Filtro de presença de location vinculado, quando informado

    • paginacao
      Type: object · PaginationDTO

      Paginação da consulta (Bacen)

    • status
      Type: string enum

      Status of a dynamic charge

      values
      • ATIVA
      • CONCLUIDA
      • REMOVIDA_PELO_USUARIO_RECEBEDOR
      • REMOVIDA_PELO_PSP