Detalhes de um Boleto

Dados da API

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

Este endpoint é utilizado para consultar os detalhes de um boleto, retornando informações completas sobre ele, como valor, status, dados do pagador e histórico de pagamento.

GET /api/billissuer/information?accountNumber={accountNumber}&id_bill={id_bill}

Este método recebe os identificadores de conta e boleto e retorna os dados detalhados.

Requisição

{
  "accountNumber": "long",
  "id": "string",
}

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que o boleto foi emitido	long	-	-
id	Identificador único do boleto	String	-	Identificador do boleto

🟢 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,
  "status": 1,
  "success": true,
  "message": "string"
}

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
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	-	-
status	Status do boleto	int	-	Formato: 1 = Processando; 2 = Emitido; 3 = Pago; 99 = Falha
success	Status da solicitação de informações	bool	-	Formato: true para solicitações recepcionadas com sucesso e false para solicitações inválidas
message	Mensagem de retorno	string	-	Mais informações do erro, se existir

Recorrência

As consultas podem ser realizadas a qualquer momento.

Informações Adicionais

As consultas podem ser realizadas a qualquer momento.