Listar no Portal Owl Pag

Todos os boletos gerados podem ser visualizados no portal OWL Pag, tanto na web quanto no app.

Os boletos são listados para o usuário com acesso a conta associado ao clientID fornecido no momento do credenciamento. Em caso de dúvidas sobre a conta associada ou sobre acesso ao portal entre em conato com nsso suporte.

Busca unitária boleto via API

Metodo FindBoletoInById

Descrição

O endpoint /Boleto/FindBoletoInById permite a consulta de um boleto específico a partir do seu identificador (documentNumber) e do identificador do cliente (clientid). Ele retorna informações detalhadas sobre o boleto, incluindo datas, valores e status.

Corpo da Requisição (JSON)

A requisição deve conter os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
`clientid`	int64	Sim	Identificador único do cliente solicitante.
`documentNumber`	string	Não	Número do documento do boleto a ser consultado.

Exemplo de Requisição

{
    "clientid": 1001,
    "documentNumber": "123456789"
}

Response

O endpoint retorna um objeto JSON com as informações do boleto consultado.

Corpo da Resposta (JSON)

Campo	Tipo	Descrição
`boletoInId`	int64	Identificador único do boleto.
`operationId`	int64	Identificador da operação relacionada ao boleto.
`dueDate`	string	Data de vencimento do boleto.
`paymentDate`	string	Data em que o boleto foi pago (se aplicável).
`creditDate`	string	Data de crédito do pagamento (se aplicável).
`creationDate`	string	Data de criação do boleto.
`principalValue`	double	Valor principal do boleto.
`interestDate`	string	Data de início dos juros.
`interestValue`	double	Valor dos juros aplicados.
`interestPercent`	double	Percentual de juros aplicado.
`fineDate`	string	Data de início da multa.
`fineValue`	double	Valor da multa.
`finePercent`	double	Percentual da multa.
`totalValue`	double	Valor total do boleto.
`rebateValue`	double	Valor de desconto aplicado (se houver).
`paidValue`	double	Valor pago pelo cliente.
`status`	int32	Status do boleto (código numérico).
`mailToSend`	string	E-mail para envio do boleto.
`phoneToSend`	string	Telefone para envio do boleto.
`ourNumber`	string	Nosso número do boleto.
`identifier`	string	Identificador único associado ao boleto.
`barcode`	string	Código de barras do boleto.
`digitableLine`	string	Linha digitável do boleto.
`url`	string	URL para acessar o boleto online.
`customerName`	string	Nome do cliente.
`customerTaxNumber`	string	CPF/CNPJ do cliente.
`divergentPaymentType`	int32	Tipo de pagamento divergente (se aplicável).
`minPaymentValue`	double	Valor mínimo permitido para pagamento.
`maxPaymentValue`	double	Valor máximo permitido para pagamento.

Exemplo de Resposta

{
    "boletoInId": 123456,
    "operationId": 78910,
    "dueDate": "2025-05-05T23:59:59",
    "paymentDate": null,
    "creditDate": null,
    "creationDate": "2025-04-01T12:00:00",
    "principalValue": 1200.00,
    "interestDate": "2025-05-06T00:00:00",
    "interestValue": 2.50,
    "interestPercent": 0.5,
    "fineDate": "2025-05-06T00:00:00",
    "fineValue": 50.00,
    "finePercent": 2.0,
    "totalValue": 1252.50,
    "rebateValue": 0.00,
    "paidValue": null,
    "status": 1,
    "mailToSend": "[email protected]",
    "phoneToSend": "11988887777",
    "ourNumber": "123456789",
    "identifier": "ABC123XYZ",
    "barcode": "00190500954014481606906809350314337370000000100",
    "digitableLine": "00190.50095 40144.816069 06809.350314 3 7370000000100",
    "url": "https://www.banco.com/boleto/123456",
    "customerName": "Carlos Souza",
    "customerTaxNumber": "987.654.321-00",
    "divergentPaymentType": null,
    "minPaymentValue": 500.00,
    "maxPaymentValue": 1300.00
}