Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
BoletosHibridos

Consulta de boleto híbrido

Retorna os detalhes de um boleto híbrido a partir do seu identificador.

get/pj/apibanking/forintegration/v1/boletos-hibridos/{id}

Path parameters

idstring uuid required

identificador para recuperação dos detalhes do boleto híbrido.

Response

OK

idstring uuid nullable
qrCodestring nullable
linhaDigitavelstring nullable
codigoBarrasstring nullable
situacao'EmProcessoValidacao' | 'ErroValidacao' | 'Validado' | 'Emitido' | 'RegistroSolicitado' | 'Registrado' | 'CancelamentoSolicitado' | 'FalhaCancelamento' | 'Cancelado' | 'FalhaLiquidacao' | 'Liquidado' | 'FalhaRegistro'

Example response

{
  "id": "40e86a96-a760-4113-aec8-4c1893eaf593",
  "qrCode": "00020126960014BR.GOV.BCB.PIX2574api-pix-h.bancobs2.com.br/spi/v2/cobv/5140df82-1586-47f5-8f94-a6a36806104d52040000530398654071647.305802BR5909Jose LTDA6006Cidade62070503***6304FA96",
  "linhaDigitavel": "21890010070990125600900000015982394890000164730",
  "codigoBarras": "21894926400000123450010012345678012345678978",
  "dadosRecebedor": {
    "documento": "191",
    "razaoSocial": "Banco do Brasil S.A",
    "agenciaConta": "0001",
    "numeroConta": "9988",
    "nomeFantasia": "Banco do Brasil"
  },
  "dadosCobranca": {
    "txId": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
    "seuNumero": "seu_numero",
    "chave": "97104715037",
    "valor": 100.5,
    "dataVencimento": "2033-08-01",
    "dataLimiteDesconto": "2033-05-31",
    "dataLimitePosVencimento": "2033-08-05",
    "valorDescontoPercentual": 10,
    "solicitacaoPagador": "Descrição livre do Solicitacao Pagador",
    "linha1": "Linha 1",
    "linha2": "Linha 2",
    "linha3": "Linha 3",
    "linha4": "Linha 4",
    "dataPagamento": "2033-08-01"
  },
  "dadosPagador": {
    "cep": "12345678",
    "nome": "Joao Silva",
    "email": "joaosilva@example.com",
    "numero": "123",
    "documento": "97104715037",
    "telefone": 71987871234,
    "bairro": "Centro",
    "estado": "SP",
    "cidade": "São Paulo",
    "logradouro": "Rua Principal",
    "complemento": "Apartamento 123"
  },
  "dadosPagadorEfetivo": {
    "nome": "EMPRESA LTDA",
    "documento": "12345678000195",
    "bancoIspb": "71027866",
    "agenciaConta": "0001",
    "numeroConta": "9999999"
  }
}