List Bank Slips
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)
List bank slips by due date
This endpoint lists issued bank slips whose due date falls within the provided range. It returns a detailed list with relevant information such as amount, status, and payer data.
GET /api/billissuer/list/by/due-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
This method returns issued bank slips whose due date is within the provided period.
Data dictionary - Parameters
| PARAMETER | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| accountNumber | Account number that issued the bank slip | long | - | - |
| startDate | Start due date | date | - | Format: YYYY-MM-DD |
| endDate | End due date | date | - | Format: YYYY-MM-DD |
- 🟢 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,
"statusBill": 1,
"statusIntegration": 1
}]
Data dictionary - Response
| FIELD | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| Id | Unique bank slip identifier | String | - | Bank slip identifier |
| Value | Original bank slip amount | decimal | 11, 2 | Format: 0.00 |
| IssueDate | Issue date | date | - | Format: YYYY-MM-DD |
| DueDate | Due date | date | - | Format: YYYY-MM-DD |
| PayerDocument | Payer document (CPF/CNPJ) | 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 amount was credited on the statement | 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 | - | - |
| statusBill | Bank slip status | int | - | 1 = Processing; 2 = Issued; 3 = Paid; 9 = Overdue; 99 = Failed |
| statusIntegration | Integration status | int | - | 1 = Processing; 2 = Issued; 9 = Rejected; 99 = Failed |
List bank slips by payment date
Used to list bank slips by the date the payment was recorded.
GET /api/billissuer/list/by/payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
This method receives a start and end payment date and returns a list of bank slips with status 3 (Paid) whose payment date is within (inclusive) the provided dates.
Data dictionary - Parameters
| PARAMETER | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| accountNumber | Account number that issued the bank slip | long | - | - |
| startDate | Start payment date | date | - | Format: YYYY-MM-DD |
| endDate | End payment date | date | - | Format: YYYY-MM-DD |
- 🟢 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,
"statusBill": 1,
"statusIntegration": 1
}]
Data dictionary - Response
| FIELD | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| Id | Unique bank slip identifier | String | - | Bank slip identifier |
| Value | Original bank slip amount | decimal | 11, 2 | Format: 0.00 |
| IssueDate | Issue date | date | - | Format: YYYY-MM-DD |
| DueDate | Due date | date | - | Format: YYYY-MM-DD |
| PayerDocument | Payer document (CPF/CNPJ) | 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 amount was credited on the statement | 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 | - | - |
| statusBill | Bank slip status | int | - | 1 = Processing; 2 = Issued; 3 = Paid; 9 = Overdue; 99 = Failed |
| statusIntegration | Integration status | int | - | 1 = Processing; 2 = Issued; 9 = Rejected; 99 = Failed |
List bank slips by credit date
This endpoint lists bank slips based on the date the amount was credited. It returns a detailed list with relevant information such as amount, status, and payer data.
GET /api/billissuer/list/by/credit-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}&statusIntegration={statusIntegration}
This method receives a start and end credit date and returns bank slips whose credit date is within the provided period.
Data dictionary - Parameters
| PARAMETER | DESCRIPTION | TYPE | SIZE | REQUIRED | NOTES |
|---|---|---|---|---|---|
| accountNumber | Account number that issued the bank slip | integer | - | Yes | - |
| startDate | Start credit date | datetime | - | Yes | Format: YYYY-MM-DD |
| endDate | End credit date | datetime | - | Yes | Format: YYYY-MM-DD |
| statusIntegration | Bank slip integration status | integer | - | No | Values: 1, 2, 9, 99 |
- 🟢 200
Response
[
{
"Id": "GUID",
"Value": "decimal",
"IssueDate": "DateTime",
"DueDate": "DateTime",
"PayerDocument": "string",
"PayerName": "string",
"PayerStreetAndNumber": "string",
"PayerZipCode": "string",
"PayerCity": "string",
"PayerCityState": "string",
"PayerNeighborhood": "string",
"PayerPhoneNumber": "string",
"EffectivePaymentDate": "DateTime",
"EffectiveCreditDate": "DateTime",
"EffectivePaymentValue": "decimal",
"BarCode": "string",
"OurNumber": "string",
"DigitableLine": "string",
"PixEmv": "string",
"OverduePaymentAllow": "boolean",
"OverduePaymentDateLimit": "DateTime",
"OverduePaymentPenalty": "decimal",
"OverduePenaltyReceived": "decimal",
"OverduePaymentInterest": "decimal",
"OverdueInterestReceived": "decimal",
"CancelDate": "DateTime",
"CancellationReason": "string",
"StatusBill": "int",
"ReferenceCode": "string"
}
]
Data dictionary - Response
| FIELD | DESCRIPTION | TYPE | SIZE | REQUIRED | NOTES |
|---|---|---|---|---|---|
| Id | Unique bank slip identifier | GUID | - | Yes | Bank slip identifier |
| Value | Original bank slip amount | decimal | 11, 2 | Yes | Format: 0.00 |
| IssueDate | Issue date | datetime | - | No | Format: YYYY-MM-DD |
| DueDate | Due date | datetime | - | Yes | Format: YYYY-MM-DD |
| PayerDocument | Payer document (CPF/CNPJ) | string | 14 | Yes | Numbers only |
| PayerName | Payer name | string | 50 | Yes | - |
| PayerZipCode | Payer ZIP code | string | 8 | Yes | Numbers only |
| PayerCity | Payer city | string | 100 | Yes | - |
| PayerCityState | Payer state (UF) | string | 2 | Yes | - |
| PayerStreetAndNumber | Payer street and number | string | 100 | Yes | - |
| PayerNeighborhood | Payer neighborhood | string | 50 | Yes | - |
| EffectivePaymentDate | Effective payment date | datetime | - | No | Format: YYYY-MM-DD |
| EffectiveCreditDate | Effective credit date | datetime | - | No | Format: YYYY-MM-DD |
| EffectivePaymentValue | Amount effectively paid | decimal | 11, 2 | No | - |
| BarCode | Barcode | string | - | No | - |
| OurNumber | Our number | string | - | No | - |
| DigitableLine | Digitable line | string | - | No | - |
| PixEmv | Pix EMV code | string | - | No | - |
| StatusBill | Bank slip status | int | - | No | 1 = Processing; 2 = Issued; 3 = Paid; 9 = Overdue; 99 = Failed |
| ReferenceCode | Bank slip reference code | string | - | No | - |