Issue a New Bank Slip

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 issues a new bank slip by adding it to the issuance/registration queue. After processing, the bank slip will be available for printing.

POST /api/billissuer/new?accountNumber={accountNumber}

This method receives billing data to issue the bank slip.

Request

{
  "issuerConfiguration": "00000000-0000-0000-0000-000000000000",
  "value": 0.00,
  "dueDate": "2023-01-01",
  "payerDocument": "string",
  "payerName": "string",
  "payerZipCode": "string",
  "payerCity": "string",
  "payerCityState": "string",
  "payerStreetAndNumber": "string",
  "payerNeighborhood": "string",
  "payerPhoneNumber": "string",
  "messageToThePayer": "string",
  "referenceCode": "string",
  "acceptOverduePayment": "string",
  "penaltyPercentMonth": 0.00,
  "interestPercentMonth": 0.00,
  "maxOverdueDays": 0
}

Data dictionary - Parameters

HEADER	DESCRIPTION	TYPE	SIZE	NOTES
accountNumber	Account number that will issue the bank slip	long	-	-
IssuerConfiguration	Additional issuance configuration	GUID	-	Used for issuance settings with interest/penalty. If not provided, the default configuration will be used.
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	-
PayerPhoneNumber	Payer phone number	string	15	Numbers only.
MessageToThePayer	Message to the payer	string	165	-
ReferenceCode	Reference code	string	20	Optional. Custom bank slip identifier.
AcceptOverduePayment	Allow payment after due date	string	1	Optional. "S" = Yes, "N" = No. If not provided, the default configuration is used.
PenaltyPercentMonth	Late payment penalty (%)	decimal	5, 2	Optional. Range: 0.50 to 40.00. Format: 0.00. If not provided, the default configuration is used.
InterestPercentMonth	Late payment interest per month (%)	decimal	5, 2	Optional. Range: 0.50 to 40.00. Format: 0.00. If not provided, the default configuration is used.
MaxOverdueDays	Maximum overdue period (days)	int	-	Optional. Range: 2 to 365 days. If not provided, the default configuration is used.

🟢 200

Response

{
"id": "00000000-0000-0000-0000-000000000000",
"success": true,
"message": "string"
}

Data dictionary - Response

HEADER	DESCRIPTION	TYPE	SIZE	NOTES
id	Unique bank slip identifier	String	-	Bank slip identifier
success	Issuance request status	bool	-	true for accepted issuance requests; false for invalid requests
message	Return message	string	-	Error details, if any

Availability

Requests can be sent at any time.

Additional Information

Issuance process

After issuance is requested, the bank slip is placed in the issuance/registration queue. This process takes about 5 minutes. After that, it can be printed.

Authentication

For all API methods (except the token endpoint), requests must be sent with a header in the following format:

Key	Value
Authorization	Bearer eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ

The authentication type Bearer never changes, and the token that follows (as in: “eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ”) corresponds to the token obtained via api/Auth/Token.

Attention

Tokens expire. It is the integrator system’s responsibility to request a new token after expiration to keep making API calls.