BSbs2
BoletosHibridos

Listagem de boletos híbridos

Retorna uma lista de boletos híbridos com base nos filtros informados.

get/pj/apibanking/forintegration/v1/boletos-hibridos

Request

  • The document declares no server URL.
  • Auth
    none required

Query parameters

SituacoesBs2Core2PixDerivadoBolepixSituacaoBoletoHibridoFiltro[]
DataIniciostring date-time
DataFimstring date-time
DocumentoPagadorstring
SeuNumerostring
PaginaAtualinteger
Example:1
QuantidadePorPaginainteger
Example:10

Response

OK

idstring uuid nullable
situacao'EmProcessoValidacao' | 'ErroValidacao' | 'Validado' | 'Emitido' | 'RegistroSolicitado' | 'Registrado' | 'CancelamentoSolicitado' | 'FalhaCancelamento' | 'Cancelado' | 'FalhaLiquidacao' | 'Liquidado' | 'FalhaRegistro'
dataVencimentostring date-time
valornumber double
documentoPagadorstring nullable
nomePagadorstring nullable
dataPagamentostring date-time nullable
seuNumerostring nullable
valorPagonumber double nullable

Example response

[
  {
    "id": "40e86a96-a760-4113-aec8-4c1893eaf593",
    "dataVencimento": "2033-08-01",
    "valor": 100.5,
    "documentoPagador": "12312312387",
    "nomePagador": "José da Silva",
    "dataPagamento": "2033-08-01",
    "seuNumero": "seu_numero",
    "valorPago": 110.5,
    "dadosPagadorEfetivo": {
      "nome": "EMPRESA LTDA",
      "documento": "12345678000195",
      "bancoIspb": "71027866",
      "agenciaConta": "0001",
      "numeroConta": "9999999"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.