Export Transactions
API details
Conciliation and Bank Slips API
These APIs are used for additional features such as generating and managing bank slips:
- Production: https://integration.sopague.com.br/sopague
- Homologation: https://api-hmg.sopague.com.br/integration
- Architecture: Representational State Transfer (REST)
Export by operation date
Used to export transaction data by the transaction (operation) date.
POST /api/transaction/concil/export-by-operation-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
Data dictionary - Query Parameters
| PARAMETER | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| accountNumber | Account number for which the operation was issued | long | - | - |
| startDate | Start date for the search | Date | 30 | Format YYYY-MM-DD |
| endDate | End date for the search | Date | 256 | Format YYYY-MM-DD |
- 🟢 200
Response
{
"fileBase64": "string"
}
Data dictionary - Response
| FIELD | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| fileBase64 | Export file in Base64 | string | - | - |
Used to export transaction data by the payment date.
POST /api/transaction/concil/export-by-payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
Data dictionary - Query Parameters
| PARAMETER | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| accountNumber | Account number for which the operation was issued | long | - | - |
| startDate | Start date for the search | Date | 30 | Format YYYY-MM-DD |
| endDate | End date for the search | Date | 256 | Format YYYY-MM-DD |
- 🟢 200
Response
{
"fileBase64": "string"
}
Data dictionary - Response
| FIELD | DESCRIPTION | TYPE | SIZE | NOTES |
|---|---|---|---|---|
| fileBase64 | Export file in Base64 | string | - | - |
Additional information
For all API methods (except the token retrieval method), requests must be sent with a header in the following format:
| Key | Value |
|---|---|
| Authorization | Bearer eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ |
Where the authentication type Bearer never changes, and the token that follows (e.g. eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ) corresponds to the token obtained via api/Auth/Token.
Important
Every token has an expiration date and time. The integrating system is responsible for requesting a new token and using it for subsequent calls after the current token expires.