Statements API Endpoints

Get eStatement PDF

GET /programs/{programCode}/accounts/{accountIdentifier}/statements/{statementPeriod}

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.

If the GET request is successful, the following response message will be returned along with a 200 HTTP status code
Programs configured for the Interest Rate feature only:

• The following changes will be made to the eStatement interest details section:

  • Interest Paid this Period changed to Interest Earned this Period
  • Interest Paid Year to Date – Will reflect the posted YTD interest total amount

  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

  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

Get eStatements List

GET /programs/{programCode}/accounts/{accountIdentifier}/statements

This endpoint allows a list of available statements to be retrieved.

If the GET request is successful, the following response message will be returned along with a 200 HTTP status code.

Note: If a statement is not available, and the accountIdentifier exists, then an empty list will be returned along with the 200 HTTP status code. If the accountIdentifier does not exist, a 404 HTTP status code will be returned.

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

Tax Document API Endpoints

Get Tax Document (INT-1099)

GET /programs/{programCode}/accounts/{accountIdentifier}/taxdocuments/{year}

This endpoint allows the retrieval of an INT-1099 form for a specific year. INT-1099 forms are only available for interest-bearing accounts that earn $10 USD or more in interest per year.

Note: Contact your Green Dot liaison for assistance with configuration.

Get Tax Document (by Type)

GET /programs/{programCode}/accounts/{accountIdentifier}/taxdocuments/{docType}/{year}

This endpoint allows the retrieval of different type form for a specific year. Like INT-1099,S-1042 forms,etc.

Note: Contact your Green Dot liaison for assistance with configuration.

Get Tax Document List (INT-1099)

GET /programs/{programCode}/accounts/{accountIdentifier}/taxdocuments

This endpoint allows the retrieval of an INT-1099 form. INT-1099 forms are only available for interest-bearing accounts that earn $10 USD or more in interest per year.

Note: Contact your Green Dot liaison for assistance with configuration.

Get Tax Document List (by Type)

GET /programs/{programCode}/accounts/{accountIdentifier}/taxdocumentsbytype/{docType}

Retrieves tax documents for the account by type

Note: Contact your Green Dot liaison for assistance with configuration.