Statements
Statements APIs can be used to retrieve statement information.
Statements API Endpoints
List Available Statements
This endpoint obtains a list of available statements for an account.
Structure of API Call
GET /programs/{programCode}/accounts/{accountIdentifier}/statements
Response Parameters
| Field | Description |
|---|---|
| responseDetails, code,subCode,description ,url | See Response Details |
| statements | A list of statements that are ready for the user. |
| accountIdentifer | Unique identifier for an account. |
| statementPeriod | The period of the statement based on the end date of the statement in the form YYYYMM. This value is then used to retrieve a specific eStatement |
| statementPeriodStartDate | Displays the start date of the statement period. |
| statementPeriodEndDate | Displays the end date of the statement period. |
eStatements List
All available eStatements will be included in the accountholder’s online Statements list. The Statements list may become long over time, so it is recommended that Partners:
- Limit the list to 2 years or less
- Implement a hide/unhide tab for accountholders to view eStatements older than 2 years
Retrieve a PDF Statement
This endpoint allows the retrieval of a PDF statement for an account and for a given period. The PDF will be base64 coded and it will return the transaction details on all transaction types.
Structure of API Call
GET /programs/{programCode}/accounts/{accountIdentifier}/statements/{statementPeriod}
API Call Structure Parameters
| Field | Type | Format | Required | Description |
|---|---|---|---|---|
| statementPeriod | String | Path | Required | The time period covered by a user’s monthly account statement, depending on the number of days during the month. Normally between 28 and 33 days. Its purpose is to summarize the economic activity of the account from the start to the end date. Note: Must be in the form YYYYMM. |
| accountIdentifier | String | Path | Required | Unique identifier for an account. |
Response Codes
| Scenario | Code | subCode | Description |
|---|---|---|---|
| The eStatement for the time period requested cannot be generated | 500 | 0 | interest Error: Cannot get interest |
eStatement Interest Details
Programs configured for the Interest Rate feature only:
- The following changes will be made to the eStatement interest details section:
- The following changes will be made to the eStatement interest details section:
- Interest Paid Year to Date – Will reflect the posted YTD interest total amount
- Example 1:
- When the Billing Cycle 2 eStatement is generated, the interest amount in the interest details section will be:
- Interest Earned this Period - $0.08
- Interest Paid Year to Date - $0.01
- When the Billing Cycle 2 eStatement is generated, the interest amount in the interest details section will be:
| eStatement | Period Start Date | Period End Date | Interest Due | Interest Posting Date |
|---|---|---|---|---|
| Billing Cycle 1 eStatement | 2020-05-22 | 2020-06-22 | 0.01 | 2020-06-25 |
| Billing Cycle 2 eStatement | 2020-06-22 | 2020-07-21 | 0.08 | 2020-07-25 |
Example 2:
- The account’s billing cycles are on the following schedule and the Interest Paid Year to Date is $1 USD for each billing cycle. When eStatement 13 is generated, the Interest Paid Year to Date will be reset to $1 USD.
| eStatement | Period Start Date | Period End Date | Interest Earned this Period | Interest Posting Date | Interest Paid Year to Date |
|---|---|---|---|---|---|
| Statement 1 | 2020-01-22 | 2020-02-21 | 1.00 | 2020-02-25 | 0.00 |
| Statement 2 | 2020-02-22 | 2020-03-21 | 1.00 | 2020-03-25 | 1.00 |
| Statement 3 | 2020-03-22 | 2020-04-21 | 1.00 | 2020-04-25 | 2.00 |
| Statement 4 | 2020-04-22 | 2020-05-21 | 1.00 | 2020-05-25 | 3.00 |
| Statement 5 | 2020-05-22 | 2020-06-21 | 1.00 | 2020-06-25 | 4.00 |
| Statement 6 | 2020-06-22 | 2020-07-21 | 1.00 | 2020-07-25 | 5.00 |
| Statement 7 | 2020-07-22 | 2020-08-21 | 1.00 | 2020-08-25 | 6.00 |
| Statement 8 | 2020-08-22 | 2020-09-21 | 1.00 | 2020-09-25 | 7.00 |
| Statement 9 | 2020-09-22 | 2020-10-21 | 1.00 | 2020-10-25 | 8.00 |
| Statement 10 | 2020-10-22 | 2020-11-21 | 1.00 | 2020-11-25 | 9.00 |
| Statement 11 | 2020-11-22 | 2020-12-21 | 1.00 | 2020-12-25 | 10.00 |
| Statement 12 | 2020-12-22 | 2021-01-21 | 1.00 | 2021-01-25 | 11.00 |
| Statement 13 | 2021-01-22 | 2021-02-21 | 1.00 | 2021-02-25 | 1.00 |
| Statement 14 | 2021-02-22 | 2021-03-21 | 1.00 | 2021-03-25 | 2.00 |
Updated 4 months ago