Category links

API Links

Get Account Statement List

Action: POST

Endpoint: /api/CoreCredit/Statement/GetAccountStatementList

Use GetAccountStatementList API can retrieve the list of historically-generated PDF statements based on the monthly cycle range. The API retrieves a list of historical statements generated for the given account within a particular statement year.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Conditional

Account Number of account holder Valid Values: 0-9 Example: 8000000000000037 Condition: At least one of Account Number\ Account id is required.

Allowable Values:

19

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 Condition: At least one of Account Number\ Account id is required.

ApplicantType

string

Optional

Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= "Applicant", 2 ="Co-Applicant", 3= "Cosigner",

Allowable Values:

20

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "5000000000000033",
  "AccountID": 8435,
  "ApplicantType": null,
  "IdentifierToken": null
}
Response fields details
Fields Description

ListStatementHistory

array

List of Historical Statements.

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "ListStatementHistory": [
      {
        "StatementYear": 2018,
        "ListStatement": [
          {
            "FileName": "July 2018",
            "FilePath": "?Path=output/6-1332/1341/Statements/2018-07-31/Normal/5000000000000033_2018-07-31_439554_4.pdf",
            "StatementID": 439554,
            "StatementDate": "03/31/2016 00:00:00"
          }
        ]
      }
    ]
  }
}