Listar Boletos

Dados da API

• Dados da API:
  • URL: https://integration.enoqbank.com/enoq
  • Arquitetura: Representational State Transfer (REST)

Listar Boleto por data de vencimento

Este conjunto de endpoints é utilizado para listar boletos com base em datas de vencimento ou pagamento. Ele retorna uma lista detalhada com as informações relevantes dos boletos, como valor, status e informações do pagador.

GET /api/billissuer/list/by/due-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Este endpoint retorna boletos emitidos cuja data de vencimento está no intervalo informado.

Requisição

{
  "accountNumber": "long",
  "startDate": "date",
  "endDate": "date",
}

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o boleto foi emitido	long	-	-
startDate	Data de vencimento inicial	date	-	Formato YYYY-MM-DD
endDate	Data de vencimento final	date	-	Formato YYYY-MM-DD

🟢 200

Resposta

[{
"id":"00000000-0000-0000-0000-000000000000",
"value":0.00,
"issueDate":"2023-01-01",
"dueDate":"2023-01-01",
"payerDocument":"string", "payerName":"string", "payerStreetAndNumber":" string ", "payerZipCode":" string ", 
"payerCity":" string ",
"payerCityState":" string ", "payerNeighborhood":"string”,
"payerPhoneNumber":"string", "effectivePaymentDate":"2023-01-01",
"effectivePaymentValue":0,
"barCode":null,
"digitableLine":null,
"pixEmv":null,
"statusBill":1,
"statusIntegration":1
}]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
Id	Identificador único do boleto	String	-	Identificador do boleto
Value	Valor original do boleto	decimal	11, 2	Formato 0.00
IssueDate	Data de emissão	date	-	Formato YYYY-MM-DD
DueDate	Data de vencimento	date	-	Formato YYYY-MM-DD
PayerDocument	-	String	14	Somente números.
PayerName	Nome do devedor	String	50	-
PayerZipCode	CEP do devedor	String	8	Somente números.
PayerCity	Cidade do devedor	String	100	-
PayerCityState	Sigla da UF do devedor	String	2	-
PayerStreetAndNumber	Logradouro e número do devedor	String	100	-
PayerNeighborhood	Bairro do devedor	String	50	-
effectivePaymentDate	Data de pagamento	Date	-	Formato YYYY-MM-DD
effectivePaymentValue	Valor do pagamento	Decimal	11, 2	-
barCode	Código de barras	String	-	-
digitableLine	Linha digitável	String	-	-
pixEmv	EMV PIX, caso habilitado para emitir PIX	String	-	-
statusBill	Status do boleto	int	-	Formato: 1 = Processando; 2 = Emitido; 3 = Recebido; 9 = Vencido; 99 = Falha;
statusIntegration	Status da integração	int	-	Formato: 1 = Processando; 2 = Emitido; 9 = Rejeitado; Falha = 99;

Listar Boleto por data pagamento

Utilizado para listar boletos por data de vencimento.

GET /api/billissuer/list/by/payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

O método recebe o um período inicial e um período final de data de vencimento e retorna uma lista de boletos com status 3 (Recebido), que compreendido entre (inclusive) as datas informadas.

Requisição

{
  "accountNumber": "long",
  "startDate": "date",
  "endDate": "date",
}

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o boleto foi emitido	long	-	-
startDate	Data de vencimento inicial	date	-	Formato YYYY-MM-DD
endDate	Data de vencimento final	date	-	Formato YYYY-MM-DD

🟢 200

Resposta

[{
"id":"00000000-0000-0000-0000-000000000000",
"value":0.00,
"issueDate":"2023-01-01",
"dueDate":"2023-01-01",
"payerDocument":"string", "payerName":"string", "payerStreetAndNumber":" string ", "payerZipCode":" string ", 	
"payerCity":" string ",
"payerCityState":" string ", "payerNeighborhood":"string”,
"payerPhoneNumber":"string", "effectivePaymentDate":"2023-01-01",
"effectivePaymentValue":0,
"barCode":null,
"digitableLine":null,
"pixEmv":null,
"statusBill":1,
"statusIntegration":1
}]

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
Id	Identificador único do boleto	String	-	Identificador do boleto
Value	Valor original do boleto	decimal	11, 2	Formato 0.00
IssueDate	Data de emissão	date	-	Formato YYYY-MM-DD
DueDate	Data de vencimento	date	-	Formato YYYY-MM-DD
PayerDocument	-	String	14	Somente números.
PayerName	Nome do devedor	String	50	-
PayerZipCode	CEP do devedor	String	8	Somente números.
PayerCity	Cidade do devedor	String	100	-
PayerCityState	Sigla da UF do devedor	String	2	-
PayerStreetAndNumber	Logradouro e número do devedor	String	100	-
PayerNeighborhood	Bairro do devedor	String	50	-
effectivePaymentDate	Data de pagamento	Date	-	Formato YYYY-MM-DD
effectivePaymentValue	Valor do pagamento	Decimal	11, 2	-
barCode	Código de barras	String	-	-
digitableLine	Linha digitável	String	-	-
pixEmv	EMV PIX, caso habilitado para emitir PIX	String	-	-
statusBill	Status do boleto	int	-	Formato: 1 = Processando; 2 = Emitido; 3 = Recebido; 9 = Vencido; 99 = Falha;
statusIntegration	Status da integração	int	-	Formato: 1 = Processando; 2 = Emitido; 9 = Rejeitado; Falha = 99;