Use Cases and Examples
Use Cases
This E-Statement Report API will provide clients with the ability to generate statement reports for their accounts and will include the details of the information available in the report.
EStatement reports Use Cases documentation:
- API to generating an e-statement report
POST /v1/reports/e-statements - API to fetch users report information for maximum of 90 days for the entire FI which contains user data, disclosure data and account data and it can be filtered based on account type and FI Customer ID
Sample Code
Here is the standard flow for generating an e-statement report :
-
POST /v1/reports/e-statements
Sample Json Request
{
"totalCount": 2,
"statementReports": [
{
"userId": "6044583b32a711ed892442010a31",
"userName": "dev",
"accountNumber": 990000,
"accountType": "SAVINGS",
"optInEstatement": "Yes",
"optInPaperStatement": "No",
"optInDateTime": "10-01-2023"
},
{
"userId": "6044583b32a711ed892442010a39",
"userName": "dev",
"accountNumber": 990000,
"accountType": "CHECKING",
"optInEstatement": "No",
"optInPaperStatement": "Yes",
"optInDateTime": "15-01-2023"
}
}
-
Upon success, the response code will be 200 when the number of accepted disclosure agreements is equal to the total count, indicating success.
If they are not equal, the response code will be 206, indicating partial content.
