Bank Slip Details

API data

Conciliation & Bank Slips API
These APIs are used for additional features such as bank slip issuance and management:

• Production: https://integration.enoqbank.com/enoq
• Sandbox: https://api-hmg.sopague.com.br/integration
• Architecture: Representational State Transfer (REST)

This endpoint retrieves bank slip details, returning complete information such as amount, status, payer data, and payment history.

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

This method receives the account and bank slip identifiers and returns the detailed data.

Request

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

Data dictionary - Parameters

HEADER	DESCRIPTION	TYPE	SIZE	NOTES
accountNumber	Account number that issued the bank slip	long	-	-
id	Unique bank slip identifier	String	-	Bank slip identifier

🟢 200

Response

{
  "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",
  "effectiveCreditDate": "2023-01-01",
  "effectivePaymentValue": 0,
  "barCode": null,
  "digitableLine": null,
  "pixEmv": null,
  "status": 1,
  "success": true,
  "message": "string"
}

Data dictionary - Response

HEADER	DESCRIPTION	TYPE	SIZE	NOTES
Id	Unique bank slip identifier	String	-	Bank slip identifier
Value	Original bank slip amount	decimal	11, 2	Format: 0.00
DueDate	Due date	date	-	Format: YYYY-MM-DD
PayerDocument	Payer document	String	14	Numbers only
PayerName	Payer name	String	50	-
PayerZipCode	Payer ZIP code	String	8	Numbers only
PayerCity	Payer city	String	100	-
PayerCityState	Payer state (UF)	String	2	-
PayerStreetAndNumber	Payer street and number	String	100	-
PayerNeighborhood	Payer neighborhood	String	50	-
effectivePaymentDate	Date the bank slip payment was recorded	Date	-	Format: YYYY-MM-DD
effectiveCreditDate	Date the bank slip payment value was credited	Date	-	Format: YYYY-MM-DD
effectivePaymentValue	Paid amount	Decimal	11, 2	-
barCode	Barcode	String	-	-
digitableLine	Digitable line	String	-	-
pixEmv	Pix EMV (if Pix issuance is enabled)	String	-	-
status	Bank slip status	int	-	1 = Processing; 2 = Issued; 3 = Paid; 99 = Failed
success	Details request status	bool	-	true for successful requests; false for invalid requests
message	Return message	string	-	Error details, if any

Availability

Queries can be made at any time.

Additional Information

Queries can be made at any time.