Category links

API Links

Account Management

The CoreCard system provides various APIs to manage account-related activities. In a broader sense, you can perform account management activities in two ways:

Adding or updating the existing account management parameters using CoreCard APIs (e. g., changing the account number if it is compromised, adding manual status, applying a manual charge-off to the account, updating network information for a closed-loop network). 
Obtaining the details of account management parameters using CoreCard APIs (e. g., account balances, account status, CBR account information, transaction history, payment history, credit limit, total due, next statement date).

Get Extended Manual Status

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetExtendedManualStatus

POST /api/CoreCredit/AccountManagement/GetExtendedManualStatus

This API is to get the details of the manual status.

Request fields detail
Fields Description

Source

string

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

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

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

Description: Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Description: Details can be obtained by admin number(Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

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": "9000000900001737",
  "AdminNumber": null
}
Response fields detail
Fields Description

AccountNumber

string

Description: Account number of cardholder. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404

Allowable Values:

19

ManualStatus

string

Description: Current Manual Status of account assigned manually Valid Values: Active, Closed etc. Format: XXXX Example: Active

AccountDerivedStatus

integer

Description: Account Derived status based on Account Status, Card Manual Status and Embossing Status. Valid Values: Possible values - Active, Blocked etc Format: XXXXX Example: Possible values -Active,Blocked, Cancelled, etc

ManualStatusList

array

List of Manual Status.

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body

{
  "application/json": {
    "Message": "Manual Status details returned successfully.",
    "Status": true,
    "ErrorCode": "ERR01139",
    "ResponseData": {
      "AccountNumber": "9000000900001737",
      "ManualStatus": "Active",
      "AccountDerivedStatus": 1,
      "ManualStatusList": [
        {
          "Priority": 1,
          "ManualStatus": "Active",
          "StatusDescription": "",
          "StartDate": "03/31/2016 00:00:00",
          "EndDate": "03/31/2016 00:00:00",
          "UserID": "",
          "IsDeleted": false,
          "EffectiveEndDate": "03/31/2016 00:00:00"
        }
      ]
    }
  }
}

Get Memo Reason

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetMemoReason

POST /api/CoreCredit/AccountManagement/GetMemoReason

Use this API to retrieve the list of memo reasons for any memo reason type.

Request fields detail
Fields Description

Source

string

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

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

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

MemoReasonType

integer

It describes type of reason for which we need Memo. Valid Values: 1 = Account Level 2 = Transaction Level 3 = Status 4 = Manual Transaction 5 = Merchant Level

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MemoReasonType": 1
}
Response fields detail
Fields Description

MemoReasonList

array

Array of Memo reason

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "MemoReasonList": [
        {
          "MemoReasonID": 1001,
          "MemoReasonDescription": "Account level Note"
        }
      ]
    }
  }
}

Get OFAC Investigation Report

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetOFACInvestigationReport

POST /api/CoreCredit/AccountManagement/GetOFACInvestigationReport

Use this API to obtain the details of all OFAC suspicious accounts returned during a Bulk OFAC screening. The OFAC record details are included for all accounts/cardholders within an institution, such as IST score (Threshold Score of OFAC set on Institution), the Name, Address, Account Number, OFAC Match Results, and the last OFAC scan date.

Request fields detail
Fields Description

Source

string

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

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

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

LastScanDate

datetime

Mandatory

Previous Date on which Account screened for OFAC as part of Bulk OFAC screening. Format:MM/DD/YYYY Example:12/20/2019

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

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,
  "InstitutionID": 3241,
  "LastScanDate": "12/20/2019 00:00:00"
}
Response fields detail
Fields Description

OFACInvestigationReport

array

Array to show OFAC records which are matched/NotMatched with Insitituion threshold.

InstitutionThreshold

string

Description: Threshold value which is set on Institution for OFAC check. Valid Values: 0-9 Example: 85

Allowable Values:

3

LastScanDate

string

Previous Date on which Account screened for OFAC as part of Bulk OFAC screening. Format:MM/DD/YYYY Example:12/20/2019

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "OFACInvestigationReport": [
        {
          "OFACScore": "95",
          "FirstName": "Alex",
          "MiddleName": null,
          "LastName": "user",
          "AddressLine1": "14 Avenue New one",
          "AddressLine2": null,
          "City": "Atlanta",
          "State": "GA",
          "Country": "US",
          "AccountNumber": "8110000000000190",
          "SecondLastName": null,
          "MatchFlag": "NotMatch",
          "AccountManualStatus": "Active",
          "OFACClearanceDate": null
        },
        {
          "OFACScore": "95",
          "FirstName": "CH",
          "MiddleName": null,
          "LastName": "CH",
          "AddressLine1": "12 Avenue New one",
          "AddressLine2": null,
          "City": "Atlanta",
          "State": "GA",
          "Country": "US",
          "AccountNumber": "8110000000000117",
          "SecondLastName": null,
          "MatchFlag": "NotMatch",
          "AccountManualStatus": "Active",
          "OFACClearanceDate": null
        }
      ],
      "InstitutionThreshold": "90",
      "LastScanDate": "Dec 20 2019 12:00AM"
    }
  }
}

Get Running Balance Report

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetRunningBalanceReport

POST /api/CoreCredit/AccountManagement/GetRunningBalanceReport

Use this API to obtain the running balance on a card account via the account number. Details such as the transaction amount, transaction ID, and transaction description are also available.

Request fields detail
Fields Description

Source

string

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

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

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

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one of the Account number or Account Id is required. <Reuired>M</Reuired>

Sample request body
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "1000000700000093"
}
Response fields detail
Fields Description

RunningBalanceReportList

array

Header of Running balance report array.

Sample response body

{
  "application/json": {
    "Message": "success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "RunningBalanceReportList": [
        {
          "AccountNumber": "1000000700000093",
          "TransactionAmount": 114.48,
          "RunningBalance": 114.48,
          "TransactionID": 187819,
          "LogicModule": "02",
          "PostTime": "12/16/2014 00:00:00",
          "DebitCreditIndicator": "Debit",
          "TransactionDescription": "614 =  BILLED FINANCE CHARGES",
          "CardAcceptorNameLocation": null
        }
      ]
    }
  }
}

Get Credit Bureau Information

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetCreditBureauInformation

POST /api/CoreCredit/AccountManagement/GetCreditBureauInformation

Use this API to fetch the Credit Bureau Information for an account's  primary applicant or co-applicant (if applicable). The API returns details such as FICO score, debt-to-income ratio, income, rental income, total revolving balance, total mortgage trades, and other factors affecting the credit bureau score.

Request fields detail
Fields Description

Source

string

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

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

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

Mandatory

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037

Allowable Values:

19

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": "8000000000000011"
}
Response fields detail
Fields Description

ApplicantInformation

array

All Credit Bureau Info for Applicant will be displayed under this section

CoApplicantInformation

array

All Credit Bureau Info for CoApplicant will be displayed under this section

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ApplicantInformation": [
        {
          "FICO": 850,
          "Income": 99000.0,
          "TotalRevolvingBalance": 571.0,
          "RentAmount": 0.0,
          "DebtToIncomeRatio": 0.18,
          "MaximumCreditLimit": 25000.0,
          "Factor1": null,
          "Factor2": null,
          "Factor3": null,
          "Factor4": null,
          "Factor5": "Too many inquiries within the past 12 months",
          "TotalMortgageTrades": 0
        }
      ],
      "CoApplicantInformation": [
        {
          "FICO": 850,
          "Income": 99000.0,
          "TotalRevolvingBalance": 571.0,
          "RentAmount": 0.0,
          "DebtToIncomeRatio": 0.18,
          "MaximumCreditLimit": 25000.0,
          "Factor1": null,
          "Factor2": null,
          "Factor3": null,
          "Factor4": null,
          "Factor5": "Too many inquiries within the past 12 months",
          "TotalMortgageTrades": 0
        }
      ]
    }
  }
}

Search Application

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/SearchApplication

POST /api/CoreCredit/AccountManagement/SearchApplication

Use this API to search any loan application request submitted in the system by providing an application number, the account holder's name, or the account number. Additionally, the API can perform an application-status-specific search by providing approved, declined, pending, or  awaiting decision information. The application status, application date, contact information, credit plan, and other data are returned.

Request fields detail
Fields Description

Source

string

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

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

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

ProductID

integer

Optional

Description: ID assigned to a Program if a Specific Product ID is Inputted, then the Applications Created under that Product will be fetched Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

MerchantID

string

Conditional

A unique id generated by corecard sytem for a merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory.

Allowable Values:

10

MerchantNumber

string

Conditional

Merchant Number which is assgined to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory

Allowable Values:

9

AccountNumber

string

Optional

Account number of cardholder/AccountHolder. *if a Specific Account Number is Inputted, then the Account Number specifc Application Details will be fetched Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404121234569

Allowable Values:

19

ApplicationNumber

int64

Optional

Unique Number generated for the Account creation Application . *if a Specific Application Number is Inputted, then the Application Number specific Application Details will be fetched Valid Values:0-9 Example:8002201421

ApplicationStatus

string

Optional

Status of the Application *if a Specific Application Status is Inputted, then the Status specific Applications Details will be fetched Valid Values: Value=""1"" Text=""Approved"" Value=""2"" Text=""Declined"" Value=""6"" Text=""Pending"" Value=""9"" Text=""Awaiting Decision"" Format:X Example: 1

Allowable Values:

20

FirstName

string

Optional

First name of account holder *if a Specific Account/Application Holder First Name is Inputted, then the First Name specific Applications Details will be fetched Valid Values:a-z Format:XXXX Example:John

Allowable Values:

50

LastName

string

Optional

Last name of account holder *if a Specific Account/Application Holder Last Name is Inputted, then the Last Name specific Applications Details will be fetched Valid Values:a-z Format:XXXX Example:Smith

Allowable Values:

50

PreQualID

string

Optional

This tag refer to Pre qualification ID. *if a Specific Prequal ID is Inputted, then the ID specific Applications Details will be fetched Valid Values:0-9 Format:XXXXX Example:10255556

Allowable Values:

10

PreQualStatus

string

Optional

This tag refer to Pre qualification Status. *if a Specific Prequal Status is Inputted, then the Status specific Applications Details will be fetched Valid Values: 1-4 Value=""1"" Text=""Incomplete PreQual"" Value=""2"" Text=""Declined"" Value=""3"" Text=""Expired "" Value=""4"" Text=""Utilized"" Format: X Example: 2

Allowable Values:

20

BatchSize

integer

Optional

Description: This Tag Defines how many number of Records will be Fetched in One Batch/Page If User didn’t Input any Value, then the Default Value as per System will be 50 Max Value Inputted can be 500 Valid Values: 0-9 Format:XXX Example:50 Condition: Default Value will be 50 and Max Value Inputted must not exceed 500

PageIndex

integer

Optional

Description: This Tag Defines which Page Number of the Index of which the Records must be Fetched Valid Values:0-9 Format:XX Example:12 Condition: Default value would be 0

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,
  "MerchantNumber": null,
  "MerchantID": "11658",
  "PreQualID": null,
  "PreQualStatus": null,
  "ApplicationNumber": null,
  "ApplicationStatus": null,
  "AccountNumber": null,
  "FirstName": null,
  "LastName": null,
  "BatchSize": null,
  "PageIndex": null
}
Response fields detail
Fields Description

SearchResult

array

This tag refer to the any search list . *In this API this tag refers to Application Search List

Sample response body

{
  "200": {
    "description": "Success",
    "schema": {
      "$ref": "#/definitions/ApplicationSearchResponseModelApiResult"
    }
  },
  "Err100001": {
    "description": "[Tag Name] can not be blank."
  },
  "Err100008": {
    "description": "Please enter valid Account Number."
  },
  "Err00016": {
    "description": "System could not process your request at this time. Please try again."
  },
  "Err00017": {
    "description": "Success."
  },
  "Err00018": {
    "description": "Record Not Found."
  },
  "Err100020": {
    "description": "[Tag Name] length is not valid."
  },
  "Err100043": {
    "description": "Invalid Value of [Tag Name]."
  },
  "ERR04226": {
    "description": "Either MerchantNumber or MerchantID is Required."
  }
}

Manual Charge-off

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/ManualChargeOff

POST /api/CoreCredit/AccountManagement/ManualChargeOff

Use this API to manually charge-off a card account when the possibility of due recovery is nil or minimal. A user may set the account's charge off status, such as "started initial charge-off" or "started final charge-off", by selecting an appropriate reason, such as Bankruptcy or Fraud. A user can also provide the start date and timing for a manual initial charge-off. Additionally, a user may provide values, such as one cycle past due or two cycles past due, when setting the timing for auto initial charge-offs.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

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

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 the account to be charged off. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

Allowable Values:

19

AdminNumber

int64

Conditional

Admin number of the account to be charged off. Valid Values: 0-9 Example: 12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

UserChargeOffStatus

integer

Optional

Status that user wants to set for mentioned account. Valid Values: 0-4 0 - Not Charged-off 1 - Pending Manual Initial Charge-off 2 - Hold Initial Charge-off 3 - Started Initial Charge-off 4 - Started Final Charge-off Format: X Example: 1 Condition: Either 1 of UserChargeOffStatus Or AutoInitialChargeOff is required.

InitialManualChargeOffReason

integer

Conditional

Reason to initiate manual charge-off Valid Values: 0-7 0 - None 1 - Credit Losses 2 - Bankruptcy 3 - Fraud 4 - Other 6 - Deceased 7 - Contractional Format: X Example: 3 Condition: Mandatory if UserChargeOffStatus has a valid value

FinalStatement

integer

Optional

If final statement is needed or not Valid Values: 0, 1 0 - No 1 - Yes Format: X Example: 1 Condition: Default 1

ManualInitialChargeOffStartDate

datetime

Optional

Start Date of Manual Initial Charge-Off Format: MM/DD/YYYY Example: 05/01/2020

TimingOption

integer

Optional

Option to initiate charge-off Valid Values: 0, 1, 2 0 - Default 1 - Charge-off Date 2 - Last Payment Date Format: X Example: 0 Condition: Pass value 0 by default

AutoInitialChargeOff

integer

Optional

Value of delinquency to be overriden wrt configured value. Valid Values: 0, 3, 4, 5, 6, 7, 8 0 - None 3 - 1 Cycle Past Due 4 - 2 Cycle Past Due 5 - 3 Cycle Past Due 6 - 4 Cycle Past Due 7 - 5 Cycle Past Due 8 - 6 Cycle Past Due Format: X Example: 3

Source

string

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

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

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 the account to be charged off. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

Allowable Values:

19

AdminNumber

int64

Conditional

Admin number of the account to be charged off. Valid Values: 0-9 Example: 12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID

UserChargeOffStatus

integer

Conditional

Status that user wants to set for mentioned account. Valid Values: 0-4 0 - Not Charged-off 1 - Pending Manual Initial Charge-off 2 - Hold Initial Charge-off 3 - Started Initial Charge-off 4 - Started Final Charge-off Format: X Example: 1 Condition: Either 1 of UserChargeOffStatus Or AutoInitialChargeOff is required.

InitialManualChargeOffReason

integer

Conditional

Reason to initiate manual charge-off Valid Values: 0-7 0 - None 1 - Credit Losses 2 - Bankruptcy 3 - Fraud 4 - Other 6 - Deceased 7 - Contractional Format: X Example: 3 Condition: Mandatory if UserChargeOffStatus has value = 1

FinalStatement

integer

Optional

If final statement is needed or not Valid Values: 0, 1 0 - No 1 - Yes Format: X Example: 1 Condition: Default 1

ManualInitialChargeOffStartDate

datetime

Optional

Start Date of Manual Initial Charge-Off Format: MM/DD/YYYY Example: 05/01/2020

TimingOption

integer

Optional

Option to initiate charge-off Valid Values: 0, 1, 2 0 - Default 1 - Charge-off Date 2 - Last Payment Date Format: X Example: 0 Condition: Pass value 0 by default

AutoInitialChargeOff

integer

Conditional

Value of delinquency to be overriden wrt configured value. Valid Values: 0, 3, 4, 5, 6, 7, 8 0 - None 3 - 1 Cycle Past Due 4 - 2 Cycle Past Due 5 - 3 Cycle Past Due 6 - 4 Cycle Past Due 7 - 5 Cycle Past Due 8 - 6 Cycle Past Due Format: X Example: 3 Condition:Either 1 of UserChargeOffStatus Or AutoInitialChargeOff is required.

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": "1000000700000093",
  "AdminNumber": null,
  "AccountID": null,
  "UserChargeOffStatus": 1,
  "InitialManualChargeOffReason": 2,
  "FinalStatement": 1,
  "ManualInitialChargeOffStartDate": null,
  "TimingOption": 0,
  "AutoInitialChargeOff": null
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Successfully applied manual charge off",
    "Status": true,
    "ErrorCode": "ERR01052",
    "ResponseData": null
  }
}

Get IST WATCH Score

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetISTWATCHScore

POST /api/CoreCredit/AccountManagement/GetISTWATCHScore

IST Watch is an OFAC screening method. The Office of Foreign Asset Control (OFAC)  department of the U.S. Treasury enforces economic and trade sanctions against countries and groups of individuals involved in terrorism, narcotics, and other disreputable activities. In this API, cardholder details such as name and address are verified against the OFAC database. If a match is found, a score is returned based on the number of matching fields. The decision is then taken based on the score.

Request fields detail
Fields Description

Source

string

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

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

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

SysOrgId

integer

Mandatory

Used for authentication and issued by Core Card. This is a static value to represent institution.

FirstName

string

Optional

First name of individual for query

MiddleName

string

Optional

Middle name of individual for query

LastName

string

Optional

Last name of individual for query

StreetAddress

string

Optional

Street address of individual for query

City

string

Optional

City of individual for query

State

string

Optional

State Name of individual for query

Country

string

Optional

Country Name of individual for query

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,
  "SysOrgId": 6,
  "FirstName": "John"
}
Response fields detail
Fields Description

SysOrgId

integer

Used for authentication and issued by Core Card. This is a static value to represent institution.

FirstName

string

First name of individual for query

MiddleName

string

Middle name of individual for query

LastName

string

Last name of individual for query

StreetAddress

string

Street address of individual for query

City

string

City of individual for query

State

string

State Name of individual for query

Country

string

Country Name of individual for query

ResponseID

string

Unique response identifier

MatchingRecords

array

Array to hold matching SDN records (if any)

Sample response body

{
  "application/json": {
    "Message": "OK",
    "Status": true,
    "ErrorCode": "ERR01528",
    "ResponseData": {
      "SysOrgId": 7,
      "FirstName": "Osama",
      "MiddleName": "",
      "LastName": "",
      "StreetAddress": "",
      "State": "",
      "Country": "",
      "ResponseID": "56784587",
      "MatchingRecords": [
        {
          "ISTWatchName": "OSAMA, Abu",
          "ISTWatchID": 11697,
          "ISTWatchStreet": "",
          "ISTWatchCity": "",
          "ISTWatchState": "",
          "ISTWatchCountry": "",
          "ISTWatchDuplicateID": 12411,
          "ISTWatchDate": "01/19/2010",
          "ISTWatchPhoneNumber": "",
          "ISTWatchMemo": "DOB 12 Sep 1973; nationality Saudi Arabia; a.k.a. ABU-SAYYAF ; a.k.a. SALAH ; a.k.a.AZIBK, Nut Al-Din Afghani a.k.a. SUL",
          "ISTWatchBALKANS": "False",
          "ISTWatchBPI_PA": "False",
          "ISTWatchCUBA": "False",
          "ISTWatchDPL": "False",
          "ISTWatchFRYM": "False",
          "ISTWatchFTO": "False",
          "ISTWatchIRAN": "False",
          "ISTWatchIRAQ": "False",
          "ISTWatchLIBYA": "False",
          "ISTWatchNKOREA": "False",
          "ISTWatchSDNT": "False",
          "ISTWatchSDNTK": "False",
          "ISTWatchSDGT": "True",
          "ISTWatchSDT": "False",
          "ISTWatchSUDAN": "False",
          "ISTWatchTALIBAN": "False",
          "ISTWatchUNITA": "False",
          "ISTWatchSDN_Type": "individual",
          "ISTWatchProgram": "SDGT",
          "ISTWatchTitle": "",
          "ISTWatchCall_Sign": "",
          "ISTWatchVess_Type": "",
          "ISTWatchTonnage": "",
          "ISTWatchGRT": "",
          "ISTWatchVess_flag": "",
          "ISTWatchVess_Owner": "",
          "ISTWatchAdd_Num": 17649,
          "ISTWatchAdd_remarks": "",
          "ISTWatchPostal_Code": "",
          "ISTWatchEffective_Date": "",
          "ISTWatchExpiration_Date": "",
          "ISTWatchStandard_Order": "",
          "ISTWatchNameSearch_Key": "OSNAAAAAAA",
          "ISTWATCHScore": 91.0
        }
      ]
    }
  }
}

Get All Accounts

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAllAccounts

POST /api/CoreCredit/AccountManagement/GetAllAccounts

This API fetches information about a specific account or a list of accounts. The user may provide an account-specific input, such as a SSN or email, or a generic input, such as institution ID or merchant ID, to fetch all accounts details matching the generic criteria.

Request fields detail
Fields Description

Source

string

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

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

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

SSN

string

Optional

SSN number of user associated with account

Allowable Values:

9

HomePhoneNumber

string

Optional

Home Phone number for the account

Allowable Values:

15

Email

string

Optional

Email ID of account holder

Allowable Values:

255

MerchantID

integer

Optional

Unique Identifier for Merchant related to account Valid Values: 0-9 Format: XXXX Example: 1234

InstitutionID

integer

Optional

Unique Identifier for Institution related to account Valid Values: 0-9 Format: XXXX Example: 1234

ProductID

integer

Optional

Unique Identifier for Product related to account Valid Values: 0-9 Format: XXXX Example: 1234

PageIndex

integer

Optional

Page can have value starting from 1-N. 1 is default. Valid Values: 0-9 Format: X Example: 1

BatchSize

integer

Optional

Limit can have value 1-100, On the basis of Page and Limit paging will be done. It will be help full when system have many account or search criteria which is passed in input is very broad. Limit can not exceed 100. It means at a time API wont return more than 100 records. 50 willl be default.

CardFlag

integer

Optional

Flag to decide the accounts which will return are of primary or secondary card holder. Default value will be always Primary. If no values are given in the tag it will take the default value. Valid Values: 0 - Primary 1 – Primary and Secondary Format: X Example: 0

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,
  "SSN": null,
  "HomePhoneNumber": null,
  "Email": null,
  "MerchantID": null,
  "InstitutionID": null,
  "ProductID": null,
  "PageIndex": null,
  "BatchSize": null,
  "CardFlag": null
}
Response fields detail
Fields Description

TotalAccounts

integer

Total number of accounts that will be returned. Valid Values:0-9 Example:10

AccountDetails

array

AccountDetails

TotalRecords

integer

Total number of records in an Array. Valid Values:0-9 Example:10

Sample response body

{
  "application/json": {
    "Message": "Account Details Return Successfully",
    "Status": true,
    "ErrorCode": "ERR01084",
    "ResponseData": {
      "TotalRecords": 10,
      "TotalAccounts": 10,
      "AccountDetails": [
        {
          "AccountNumber": "9000000500000014",
          "PrimaryCardNumber": "8576",
          "AdminNumber": 129303,
          "CurrentBalance": 0.0,
          "LastStatementBalance": 0.0,
          "MinimumDue": 0.0,
          "PaymentDueDate": "02/10/2017 00:00:00",
          "GeneratedStatus": 2,
          "ManualStatus": 2,
          "MerchantID": 11527,
          "InstitutionID": 3189,
          "ProductID": 3351,
          "FirstName": "John",
          "MiddleName": null,
          "LastName": "Smith",
          "AddressLine1": "Add1",
          "AddressLine2": "Add2",
          "City": "City",
          "State": "AK",
          "Country": null,
          "PostalCode": "43633",
          "Phone": "456346346364",
          "EmailID": "Test1@gmail1.com",
          "OfficePhoneNumber": null,
          "MobilePhoneNumber": null,
          "FaxNumber": null,
          "OtherPhoneNumber": null,
          "SSN": null,
          "LastStatementDate": "01/10/2017 00:00:00",
          "CustomerID": "167261",
          "CardType": 1,
          "EmbossingManualStatus": "2",
          "EmbossingGeneratedStatus": null,
          "OFACMatchedBy": "0",
          "GracePaymentDueDate": "02/15/2018 00:00:00"
        }
      ]
    }
  }
}

Debit Card Management

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/DebitCardManagement

POST /api/CoreCredit/AccountManagement/DebitCardManagement

To make payments on credit card purchases, an external bank account debit card number may be mapped in the system. A debit card may be added or deleted and tokens may be generated against the provided  card. A payment schedule may also be initiated. 

Request fields detail
Fields Description

Source

string

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

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

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

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037

AdminNumber

int64

Conditional

Admin number. Valid Values: 0-9 Example: 12345

RequestType

integer

Mandatory

Request Type (0 = Add Debit Card, 1 = Delete Debit Card, 2 = Generate Debit Card Token using Debit Card Information) Valid Values: 0, 1, 2

Token

string

Conditional

A hash value getting generated based on Request Type Required If Request Type = 0(Add Debit Card, 1 = Delete Debit Card) Valid Values: 0-1, A-Z

DebitCardNumber

string

Conditional

16 Digit Card Number mentioned in debit card Required If Request Type = 0 (Add Debit Card)

ExpirationDate

string

Conditional

Expiration Date mentioned on Debit card Required If Request Type = 0 (Add Debit Card) Format: MM/YYYY Example: 02/2020

CardCVV

string

Conditional

CVV Number of the card

MethodName

string

Conditional

Method Name uniquely identifies Debit Card information in Core card system. Whenever user adds any Debit card information, this API returns Method Name against successful addition of bank account. Required if request type = 1 (delete request)

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": "9000000500000048",
  "RequestType": 0,
  "Token": "12346",
  "DebitCardNumber": "4256368978459696",
  "ExpirationDate": "02/2022",
  "CardCVV": "069"
}
Response fields detail
Fields Description

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers example - If we pass blank User Id and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the core card internal servers.

MethodName

string

This will be returned when new Debit Card will be added.

Sample response body

{
  "application/json": {
    "Message": "Debit Card Management Added",
    "Status": true,
    "ErrorCode": "ERR01132",
    "ResponseData": {
      "ResponseID": "56894601",
      "MethodName": "3243"
    }
  }
}

Get Network Detail

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetNetworkDetail

POST /api/CoreCredit/AccountManagement/GetNetworkDetail

Use this API to retrieve details of a specific merchant network by using the institution ID, network ID, or a list of networks within an institution. Retrieved network details include the mapped merchant status, network creation date, and the last modified date.

Request fields detail
Fields Description

Source

string

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

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

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

InstitutionID

integer

Mandatory

Institution ID Valid Values: 0-9 Example: 12345

NetworkID

int64

Optional

Network ID Need to Input if response Required for a specific Network Valid Values: 0-9 Example: 12345

NetworkName

string

Optional

Name of the Network Need to Input if response Required for a specific Network

Allowable Values:

50

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,
  "InstitutionID": 3235,
  "NetworkID": null,
  "NetworkName": null
}
Response fields detail
Fields Description

NetWorkDetailList

array

NetWorkDetailList

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body

{
  "application/json": {
    "Message": "Records found",
    "Status": true,
    "ErrorCode": "ERR01179",
    "ResponseData": {
      "NetWorkDetailList": [
        {
          "MerchantMappingExists": 1,
          "NetworkID": 1001,
          "NetworkName": "Network_1",
          "NetworkDescription": "Desc",
          "InstitutionID": 3235,
          "NetworkCreationDateTime": "01/15/2017 12:39:24",
          "NetworkLastModfiedTime": "01/15/2017 12:39:24"
        },
        {
          "MerchantMappingExists": 1,
          "NetworkID": 1002,
          "NetworkName": "Network_2",
          "NetworkDescription": "Desc",
          "InstitutionID": 3235,
          "NetworkCreationDateTime": "01/15/2017 12:59:44",
          "NetworkLastModfiedTime": "01/15/2017 12:59:44"
        },
        {
          "MerchantMappingExists": 0,
          "NetworkID": 1003,
          "NetworkName": "Network_3",
          "NetworkDescription": "Desc",
          "InstitutionID": 3235,
          "NetworkCreationDateTime": "01/15/2017 13:00:05",
          "NetworkLastModfiedTime": "01/15/2017 13:00:05"
        }
      ]
    }
  }
}

Manage Network Detail

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/UpdateDeleteNetworkDetail

POST /api/CoreCredit/AccountManagement/UpdateDeleteNetworkDetail

Use this API to delete or update an existing network attribute.

Note

If an existing network has an active merchant mapping on the network, then such a network cannot be deleted.

Request fields detail
Fields Description

Source

string

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

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

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

DecisionFlag

integer

Mandatory

Decision Flag must accept two values '0' and '1' If User Inputs '0' then the API must update the Network Details Inputted If User Inputs '1' then the API must delete the Network Details Inputted Valid Values: 0, 1 Example: 0 - Update, 1 - Delete

NetworkID

integer

Mandatory

On The basis of the Inputted Network ID, the Network Details will be Updated or Deleted depending on the 'Decision Flag' Valid Values: 0-9 Example: 12345

NetworkName

string

Conditional

Name of the Network If in Decision Flag is '0' then it is Mandatory If in Decision Flag is '1' then it is Optional

Allowable Values:

50

NetworkDescription

string

Optional

Input Network Description to be Updated

Allowable Values:

200

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,
  "DecisionFlag": null,
  "NetworkID": 1001,
  "NetworkName": "Network_1 Updated",
  "NetworkDescription": "Desc Updated"
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Network updated successfully",
    "Status": true,
    "ErrorCode": "ERR01181",
    "ResponseData": null
  }
}

Get Account Balance

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAccountBalance

POST /api/CoreCredit/AccountManagement/GetAccountBalance

Use this API to retrieve information related to account balances, such as current balance, available reward balance, last payment amount and date, total amount due, and beginning reward balance.

Request fields detail
Fields Description

Source

string

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

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

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Example: 12345 Condition: At least one of AccountNumber or AdminNumber is required.

AccountNumber

string

Conditional

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber or AdminNumber is required.

Allowable Values:

19

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": null,
  "AdminNumber": 61992
}
Response fields detail
Fields Description

TotalAmountDue

decimal

Total amount due as on statement date. Example: 200.00

CurrentBalance

decimal

Current balance of account. Example: 200.00

PaymentDueDate

datetime

Due date as to by when payment needs to be made to avoid late fees. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

LastPaymentAmount

decimal

Last payment amount on the account. Example: 200.00

LastPurchaseAmount

decimal

Last Purchase Amount as on statement date. Example: 200.00

RecentPurchasesAndDebits

decimal

Purchase and Debits made on current statement recently. Example: 200.00

RecentPaymentsAndCredits

decimal

Payments and Credits made on current statement recently. Example: 200.00

LastStatementBalance

decimal

Balance of previous statement. Example: 200.00

NextStatementDate

datetime

Next Date for Statement Generation. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

CreditLimit

decimal

Total Credit Limit on account. Example: 200.00

MaskedCardNumber

string

Masked Card Number. Format: XXXX XXXX XXXX XXXX Example: 4567 89XX XXXX 0123

Allowable Values:

19

AvailableCreditLimit

decimal

Total Credit limit minus the total amount due. Example: 200.00

LastPaymentDate

datetime

Date of last payment transaction. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

PreviousStatementDate

datetime

Date of Previous Statement. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

BeginningRewardBalance

decimal

Reward balance at the beginning of Statement. Example: 200.00

RewardEarned

decimal

Reward Earned in statement Cycle. Example: 200.00

RewardRedeemed

decimal

Reward points Redeemed in statement Cycle. Example: 200.00

AvailableRewardBalance

decimal

Number of Available Reward Balance. Example: 200.00

RewardExpired

decimal

Number of Expired Rewards. Example: 200.00

RewardForfeited

decimal

Number of Forfeited Rewards. Example: 200.00

CustomerID

string

This tag reflects the customer ID. Example: 12345

Allowable Values:

50

CardNumberLast4Digit

string

Last 4 digits of card number. Example: 1234

Allowable Values:

4

CardStatus

string

This tag reflects the status of the card. Example: Active

Allowable Values:

50

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "TotalAmountDue": 0.0,
      "CurrentBalance": 1000.0,
      "PaymentDueDate": null,
      "LastPaymentAmount": 0.0,
      "LastPurchaseAmount": 0.0,
      "RecentPurchasesAndDebits": 0.0,
      "RecentPaymentsAndCredits": 0.0,
      "LastStatementBalance": 0.0,
      "NextStatementDate": "03/23/2020 00:00:00",
      "CreditLimit": 1500.0,
      "MaskedCardNumber": "461668XXXXXX1592",
      "AvailableCreditLimit": 1500.0,
      "LastPaymentDate": null,
      "PreviousStatementDate": null,
      "BeginningRewardBalance": 0.0,
      "RewardEarned": 0.0,
      "RewardRedeemed": 0.0,
      "AvailableRewardBalance": 0.0,
      "RewardExpired": 0.0,
      "RewardForfeited": 0.0,
      "CustomerID": "44570",
      "CardNumberLast4Digit": "1592",
      "CardStatus": "Active"
    }
  }
}

Manage Memo

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/ManageMemo

POST /api/CoreCredit/AccountManagement/ManageMemo

Use this API to either delete or update an existing memo present on the card account based on the decision flag.

Request fields detail
Fields Description

Source

string

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

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

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

MemoUniqueID

string

Mandatory

A unique ID for the added memo. Format: A-Z, 0-9 Example: 2345

Allowable Values:

25

DecisionFlag

integer

Mandatory

Flag to decide if memo need to be delete or edit. Valid Values: 1 is to update memo 2 is to delete memo

MemoReason

integer

Optional

ID of added Memo Reason. Valid Values: Its value will be pulled by GetMemoReason API. Example: Account related notes. Condition: 'MemoReason' is required only when 'Decision Flag' value would be '1' (Update memo)

MemoPriority

integer

Optional

It defines if the note is urgent. If priority is set as 'YES' then it will show on top of Memo list. Its default value would be '0'(NO). Valid Values: 0 = No and 1 = Yes Condition: 'MemoPriority' is required only when 'Decision Flag' value would be '1' (Update memo).

MemoText

string

Optional

Text of the Memo. Valid Values: 0-9,a-z,special characters Example: New Transaction posted. Condition: 'MemoText' is required only when 'Decision Flag' value would be '1' (Update memo)

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,
  "MemoUniqueID": "50211",
  "DecisionFlag": 1,
  "MemoReason": 12,
  "MemoPriority": 0,
  "MemoText": "This is text memo"
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Memo updated successfully.",
    "Status": true,
    "ErrorCode": "ERR01628",
    "ResponseData": null
  }
}

Add New Memo

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/AddNewMemo

POST /api/CoreCredit/AccountManagement/AddNewMemo

Use this API to add an account, merchant or transaction level memo for a specific card account based on decision flag.

Request fields detail
Fields Description

Source

string

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

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

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

DecisionFlag

integer

Mandatory

Decide if Memo is account level,transaction level or merchant level. Valid Values: '1' is for Account level memo '2' is for Merchant level memo. '3' is for Transaction level.

AccountNumber

string

Conditional

Account number of cardholder. Valid Values: 0-9 Example: 7314145404 Condition: 1 At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 - Account level Memo. 2 Client who support duplicate Account number, they need to provide Merchant number as well.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: 1 At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 -Account level Memo.

MerchantNumber

integer

Conditional

Merchant Number which is assigned to a Merchant. Valid Values:0-9 Example: 205136549 Condition: 'MerchantNumber' is mandatory when 'Decision Flag' value would be '2' (Merchant Level memo)

TransactionID

int64

Conditional

Transaction Number for transaction being posted. Valid Values:0-9 Example:23654789 Condition: 'TransactionID' is mandatory when 'Decision Flag' value would be '3' (Transaction Level memo)

MemoReasonID

integer

Optional

Description- ID of added Memo Reason. Valid Values: Its value will be pulled by GetMemoReason API Example: Account related notes.

Allowable Values:

50

MemoPriority

integer

Optional

It defines if the note is urgent. If priority is set as YES then it will show on top of Memo list. Its default value would be 0 -NO Valid Values: 0 = No and 1 = Yes

MemoText

string

Mandatory

Text of the Memo. Valid Values: 0-9,a-z,special characters Example: New Transaction posted.

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,
  "DecisionFlag": 1,
  "AccountNumber": "8000000000000250",
  "AdminNumber": null,
  "MerchantNumber": null,
  "TransactionID": null,
  "MemoReasonID": null,
  "MemoPriority": 1,
  "MemoText": "New Transaction posted."
}
Response fields detail
Fields Description

MemoUniqueID

string

A unique ID for the added memo. Format: XXXXXXX Example: 2345

Allowable Values:

50

MemoCreationDateTime

datetime

Date and Time of Memo creation Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 10:05:05

Sample response body

{
  "application/json": {
    "Message": "Memo has been added successfully.",
    "Status": true,
    "ErrorCode": "ERR01027",
    "ResponseData": {
      "MemoUniqueID": "50198",
      "MemoCreationDateTime": "12/13/2016 23:03:15"
    }
  }
}

Get Portfolio ID History

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetPortfolioIDHistory

POST /api/CoreCredit/AccountManagement/GetPortfolioIDHistory

Use this API to fetch the historical portfolio IDs linked to an account using the account number. API returns the list of the portfolio ID, its description, and it's the effective date, associated banking partner name etc.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

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

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

Mandatory

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20

PageIndex

integer

Optional

Number of page Valid Values:0-9 Format: XX Example: 12 Condition: Default value would be 0

Source

string

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

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

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

Mandatory

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch Valid Values: 0-9 Format: XX Example: 20

PageIndex

integer

Optional

Number of page Valid Values:0-9 Format: XX Example: 12 Condition: Default value would be 0

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": "8000000000000326",
  "BatchSize": 50,
  "PageIndex": 0
}
Response fields detail
Fields Description

PortfolioIDTotalCount

integer

Description: It displays total portfolio IDs fetched for the account Valid Values: 0-9 Format: XX Example: 2

GetPortfolioHistoryList

array

Description: It displays total portfolio IDs fetched for the account Valid Values:0-9 Format:XX Example:2

PortfolioIDTotalCount

integer

Description: It displays total portfolio IDs fetched for the account Valid Values: 0-9 Format: XX Example: 2

GetPortfolioHistoryList

array

Description: It displays total portfolio IDs fetched for the account Valid Values:0-9 Format:XX Example:2

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "ERR0000",
    "ResponseData": {
      "PortfolioIDTotalCount": null,
      "GetPortfolioHistoryList": [
        {
          "MerchantName": "abc",
          "ProductName": "ABC Product",
          "InstitutionID": 3235,
          "AccountNumber": "8000000000000326",
          "FirstName": "JOY",
          "LastName": "KEYTON",
          "PortfolioID": "MSB_ECP",
          "PIDEffectiveDateTime": "05/03/2019 06:45:01",
          "PortfolioDescription": "Midland Bank",
          "LocationID": "00000013",
          "ReceivableOwner": "Midland",
          "AccountOwner": "Midland"
        }
      ]
    }
  }
}

Get Merchant By Network

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetMerchantByNetwork

POST /api/CoreCredit/AccountManagement/GetMerchantByNetwork

Use this API to retrieve the list of merchants linked to any merchant network by using the card account number.

Request fields detail
Fields Description

Source

string

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

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

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 cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

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 AccountNumber/AccountID/AdminNumber is required.

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one of AccountNumber/AccountID/AdminNumber is required.

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": "8000000000000037",
  "AccountID": 167495,
  "AdminNumber": 129364
}
Response fields detail
Fields Description

MerchantByNetworkDetailList

array

Get or set MerchantByNetworkDetailList

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "MerchantByNetworkDetailList": [
        {
          "MerchantNumber": 26,
          "MerchantID": 5030,
          "MerchantName": "ABC_merchant"
        },
        {
          "MerchantNumber": 27,
          "MerchantID": 6001,
          "MerchantName": "ABC_CanadaMerchant"
        }
      ]
    }
  }
}

Get Account Charge-off Balances

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAccountChargeOffBalances

POST /api/CoreCredit/AccountManagement/GetAccountChargeOffBalances

Use this API to retrieve all the charge-off balances, recovery fees, pending fees, late fees, annual fees etc. for a card account.

Request fields detail
Fields Description

Source

string

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

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

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 cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AccountID/AdminNumber 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 AccountNumber/AccountID/AdminNumber is required.

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one of AccountNumber/AccountID/AdminNumber is required.

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": "8000000000000029",
  "AccountID": 167494,
  "AdminNumber": 129363
}
Response fields detail
Fields Description

BalanceCO

decimal

Balance on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

PrincipalATCO

decimal

Principal amount of loan at time of account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsufficientFeesATBNPCO

decimal

Pending fees on bill not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

LateFeesBNPATCO

decimal

Late fees on billing not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsuranceFeesBNPATCO

decimal

Insurance fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InterestBNPATCO

decimal

Interest on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

TransactionFeesBNPATCO

decimal

Transaction fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

AnnualFeesBNPATCO

decimal

Annual fees on bill not paid at charge off of account Valid Values: 0-9 Format: $XX.XX Example: $100.00

RecoveryFeesBNPATCO

decimal

Recovery fees on bill not paid at charge off on account Valid Values: 0-9 Format: $XX.XX Example: $100.00

OverlimitFeesBNPATCO

decimal

Overlimit fees on bill not paid on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CollectionFeesBNPATCO

decimal

Collection fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CashBalanceCO

decimal

Cash Balance on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "BalanceCO": 0.0,
      "PrincipalATCO": 0.0,
      "InsufficientFeesATBNPCO": 0.0,
      "LateFeesBNPATCO": 0.0,
      "InsuranceFeesBNPATCO": 0.0,
      "InterestBNPATCO": 0.0,
      "TransactionFeesBNPATCO": 0.0,
      "AnnualFeesBNPATCO": 0.0,
      "RecoveryFeesBNPATCO": 0.0,
      "OverlimitFeesBNPATCO": 0.0,
      "CollectionFeesBNPATCO": 0.0,
      "CashBalanceCO": 0.0
    }
  }
}

Get Regulation Parameters

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetRegulationParameters

POST /api/CoreCredit/AccountManagement/GetRegulationParameters

Use this API service to get details of the SCRA and reservist details which are applied on a card account. Account ID is a mandatory field to provide in the request of this API which fetches out the details of the Applicant or Co-Applicant or Co-signer benefits start date, end date, and a number of cycles reservist benefit availed on the card account.

Request fields detail
Fields Description

Source

string

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

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

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

AccountID

integer

Mandatory

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345

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,
  "AccountID": 161563
}
Response fields detail
Fields Description

ReservistHistory

array

reservistHistory list

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ReservistHistory": [
        {
          "ApplicantType": "Applicant",
          "ReservistBenefitStartDate": "06/05/2020 00:00:00",
          "ReservistBenefitEndDate": "07/31/2020 23:59:57",
          "ReservistServiceEndDate": "06/30/2020 00:00:00",
          "ReservistBenefitEndNoticeDate": null,
          "ReservistBenefitUsedYTDOnCustomer": 0
        },
        {
          "ApplicantType": "Cosigner",
          "ReservistBenefitStartDate": "07/05/2020 00:00:00",
          "ReservistBenefitEndDate": "09/23/2020 23:59:57",
          "ReservistServiceEndDate": "12/12/2020 00:00:00",
          "ReservistBenefitEndNoticeDate": null,
          "ReservistBenefitUsedYTDOnCustomer": 0
        }
      ]
    }
  }
}

Reset Generated Status

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/ResetGeneratedStatus

POST /api/CoreCredit/AccountManagement/ResetGeneratedStatus

Use this API to reset the account generated status. Resetting of an account status would place the account into the status which was applicable before the current applicable status. (in most cases, the previous status is active).

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

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

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

Source

string

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

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

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

Sample request body
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": null,
  "AccountNumber": "0000000000052070"
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Generated Status has been reset successfully",
    "Status": true,
    "ErrorCode": "ERR01020",
    "ResponseData": {}
  }
}

Get Payment Allocation Plans

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetPaymentAllocationPlans

POST /api/CoreCredit/AccountManagement/GetPaymentAllocationPlans

Use this API to get a detailed view of payment allocation of an account holder as per the different plans using transaction ID and Transaction source. API fetch out the details such as plan name, beginning balances, the sum of transaction amount for fees, amount of interest charged on the transactions, the principal amount of the loan, and other details related to CPM.

Request fields detail
Fields Description

Source

string

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

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

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

TransactionId

int64

Mandatory

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXX Example:236547895

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,
  "TransactionId": 594026,
  "TransactionSource": "MANUAL"
}
Response fields detail
Fields Description

PaymentAllocationPlans

array

Payment Allocation Plan list.

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "PaymentAllocationPlans": [
        {
          "BeginningBalance": 46322.0,
          "Fees": 0.0,
          "Interest": 0.0,
          "Principle": 720.0,
          "CurrentBalance": 45602.0,
          "CPMID": "5231",
          "CreditPlanType": "Purchase",
          "PlanName": "ABC00024"
        }
      ]
    }
  }
}

Get Payment Delinquency History

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetPaymentDelinquencyHistory

POST /api/CoreCredit/AccountManagement/GetPaymentDelinquencyHistory

Use this API to retrieve information related to account balances, such as current balance, available reward balance, last payment amount and date, total amount due, and beginning reward balance.

Request fields detail
Fields Description

Source

string

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

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

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

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

AccountNumber

string

Conditional

CardHolder's Account number. Format:XXXXX Example:12346453535365 Condition:At least one of AccountNumber/AccountID is required.

Allowable Values:

19

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,
  "AccountID": 5994,
  "AccountNumber": null
}
Response fields detail
Fields Description

PayHistoryCtrCC01

integer

Delinquency History Counter for previous 01 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC02

integer

Delinquency History Counter for previous 02 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC03

integer

Delinquency History Counter for previous 03 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC04

integer

Delinquency History Counter for previous 04 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC05

integer

Delinquency History Counter for previous 05 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC06

integer

Delinquency History Counter for previous 06 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC07

integer

Delinquency History Counter for previous 07 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC08

integer

Delinquency History Counter for previous 08 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC09

integer

Delinquency History Counter for previous 09 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC10

integer

Delinquency History Counter for previous 10 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC11

integer

Delinquency History Counter for previous 11 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC12

integer

Delinquency History Counter for previous 12 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC13

integer

Delinquency History Counter for previous 13 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC14

integer

Delinquency History Counter for previous 14 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC15

integer

Delinquency History Counter for previous 15 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC16

integer

Delinquency History Counter for previous 16 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC17

integer

Delinquency History Counter for previous 17 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC18

integer

Delinquency History Counter for previous 18 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC19

integer

Delinquency History Counter for previous 19 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC20

integer

Delinquency History Counter for previous 20 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC21

integer

Delinquency History Counter for previous 21 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC22

integer

Delinquency History Counter for previous 22 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC23

integer

Delinquency History Counter for previous 23 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PayHistoryCtrCC24

integer

Delinquency History Counter for previous 24 cycle Valid Values: Delinquency Buckets Format: A-Z a-z

PaymentHistoryCounter1CycAgo

integer

History Counter Reported for previous 01 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 1 Cycle Past Due

PaymentHistoryCounter2CycAgo

integer

History Counter Reported for previous 02 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 2 Cycle Past Due

PaymentHistoryCounter3CycAgo

integer

History Counter Reported for previous 03 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 3 Cycle Past Due

PaymentHistoryCounter4CycAgo

integer

History Counter Reported for previous 04 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 4 Cycle Past Due

PaymentHistoryCounter5CycAgo

integer

History Counter Reported for previous 05 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 5 Cycle Past Due

PaymentHistoryCounter6CycAgo

integer

History Counter Reported for previous 06 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 6 Cycle Past Due

PaymentHistoryCounter7CycAgo

integer

History Counter Reported for previous 07 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 7 Cycle Past Due

PaymentHistoryCounter8CycAgo

integer

History Counter Reported for previous 08 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 8 Cycle Past Due

PaymentHistoryCounter9CycAgo

integer

History Counter Reported for previous 09 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 7 Cycle Past Due

PaymentHistoryCounter10CycAgo

integer

History Counter Reported for previous 10 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 10 Cycle Past Due

PaymentHistoryCounter11CycAgo

integer

History Counter Reported for previous 11 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 11 Cycle Past Due

PaymentHistoryCounter12CycAgo

integer

History Counter Reported for previous 12 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 12 Cycle Past Due

PaymentHistoryCounter13CycAgo

integer

History Counter Reported for previous 13 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 13 Cycle Past Due

PaymentHistoryCounter14CycAgo

integer

History Counter Reported for previous 14 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 14 Cycle Past Due

PaymentHistoryCounter15CycAgo

integer

History Counter Reported for previous 15 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 15 Cycle Past Due

PaymentHistoryCounter16CycAgo

integer

History Counter Reported for previous 16 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 16 Cycle Past Due

PaymentHistoryCounter17CycAgo

integer

History Counter Reported for previous 17 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 17 Cycle Past Due

PaymentHistoryCounter18CycAgo

integer

History Counter Reported for previous 18 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 18 Cycle Past Due

PaymentHistoryCounter19CycAgo

integer

History Counter Reported for previous 19 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 19 Cycle Past Due

PaymentHistoryCounter20CycAgo

integer

History Counter Reported for previous 20 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 20 Cycle Past Due

PaymentHistoryCounter21CycAgo

integer

History Counter Reported for previous 21 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 21 Cycle Past Due

PaymentHistoryCounter22CycAgo

integer

History Counter Reported for previous 22 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 22 Cycle Past Due

PaymentHistoryCounter23CycAgo

integer

History Counter Reported for previous 23 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 23 Cycle Past Due

PaymentHistoryCounter24CycAgo

integer

History Counter Reported for previous 24 cycle Valid Values: Delinquency Buckets Format: A-Z a-z Example: 24 Cycle Past Due

PaymentDateCounter1CycAgo

datetime

Last udpate date of payment for 01 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter2CycAgo

datetime

Last udpate date of payment for 02 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter3CycAgo

datetime

Last udpate date of payment for 03 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter4CycAgo

datetime

Last udpate date of payment for 04 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter5CycAgo

datetime

Last udpate date of payment for 05 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter6CycAgo

datetime

Last udpate date of payment for 06 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter7CycAgo

datetime

Last udpate date of payment for 07 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter8CycAgo

datetime

Last udpate date of payment for 08 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter9CycAgo

datetime

Last udpate date of payment for 09 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter10CycAgo

datetime

Last udpate date of payment for 10 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter11CycAgo

datetime

Last udpate date of payment for 11 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter12CycAgo

datetime

Last udpate date of payment for 12 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter13CycAgo

datetime

Last udpate date of payment for 13 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter14CycAgo

datetime

Last udpate date of payment for 14 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter15CycAgo

datetime

Last udpate date of payment for 15 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter16CycAgo

datetime

Last udpate date of payment for 16 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter17CycAgo

datetime

Last udpate date of payment for 17 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter18CycAgo

datetime

Last udpate date of payment for 18 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter19CycAgo

datetime

Last udpate date of payment for 19 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter20CycAgo

datetime

Last udpate date of payment for 20 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter21CycAgo

datetime

Last udpate date of payment for 21 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter22CycAgo

datetime

Last udpate date of payment for 22 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter23CycAgo

datetime

Last udpate date of payment for 23 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentDateCounter24CycAgo

datetime

Last udpate date of payment for 24 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentUserCounter1CycAgo

string

Last udpated user of Payment 01 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User01

PaymentUserCounter2CycAgo

string

Last udpated user of Payment 02 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User02

PaymentUserCounter3CycAgo

string

Last udpated user of Payment 03 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User03

PaymentUserCounter4CycAgo

string

Last udpated user of Payment 04 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User04

PaymentUserCounter5CycAgo

string

Last udpated user of Payment 05 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User05

PaymentUserCounter6CycAgo

string

Last udpated user of Payment 06 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User06

PaymentUserCounter7CycAgo

string

Last udpated user of Payment 07 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User07

PaymentUserCounter8CycAgo

string

Last udpated user of Payment 08 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User08

PaymentUserCounter9CycAgo

string

Last udpated user of Payment 09 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User09

PaymentUserCounter10CycAgo

string

Last udpated user of Payment 10 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User10

PaymentUserCounter11CycAgo

string

Last udpated user of Payment 11 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User11

PaymentUserCounter12CycAgo

string

Last udpated user of Payment 12 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User12

PaymentUserCounter13CycAgo

string

Last udpated user of Payment 13 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User13

PaymentUserCounter14CycAgo

string

Last udpated user of Payment 14 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User14

PaymentUserCounter15CycAgo

string

Last udpated user of Payment 15 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User15

PaymentUserCounter16CycAgo

string

Last udpated user of Payment 16 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User16

PaymentUserCounter17CycAgo

string

Last udpated user of Payment 17 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User17

PaymentUserCounter18CycAgo

string

Last udpated user of Payment 18 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User18

PaymentUserCounter19CycAgo

string

Last udpated user of Payment 19 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User19

PaymentUserCounter20CycAgo

string

Last udpated user of Payment 20 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User20

PaymentUserCounter21CycAgo

string

Last udpated user of Payment 21 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User21

PaymentUserCounter22CycAgo

string

Last udpated user of Payment 22 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User22

PaymentUserCounter23CycAgo

string

Last udpated user of Payment 23 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User23

PaymentUserCounter24CycAgo

string

Last udpated user of Payment 24 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User24

NumberOfMonthsWithBalance

integer

get or set NumberOfMonthsWithBalance

NumberOfMonthsWithPurchase

integer

get or set NumberOfMonthsWithPurchase

LastSkipPymtDate

string

get or set LastSkipPymtDate

LastSkipPymtAmt

string

get or set LastSkipPymtAmt

NumberOfSkipPayments

integer

get or set NumberOfSkipPayments

DelinHistoryCtrCC01

integer

get or set DelinHistoryCtrCC01

DelinHistoryCtrCC02

integer

get or set DelinHistoryCtrCC02

DelinHistoryCtrCC03

integer

get or set DelinHistoryCtrCC03

DelinHistoryCtrCC04

integer

get or set DelinHistoryCtrCC04

DelinHistoryCtrCC05

integer

get or set DelinHistoryCtrCC05

DelinHistoryCtrCC06

integer

get or set DelinHistoryCtrCC06

DelinHistoryCtrCC07

integer

get or set DelinHistoryCtrCC07

DelinHistoryCtrCC08

integer

get or set DelinHistoryCtrCC08

DelinHistoryCtrCC09

integer

get or set DelinHistoryCtrCC09

DelinHistoryCtrCC10

integer

get or set DelinHistoryCtrCC10

DelinHistoryCtrCC11

integer

get or set DelinHistoryCtrCC11

DelinHistoryCtrCC12

integer

get or set DelinHistoryCtrCC12

DelinHistoryCtrCC13

integer

get or set DelinHistoryCtrCC13

DelinHistoryCtrCC14

integer

get or set DelinHistoryCtrCC14

DelinHistoryCtrCC15

integer

get or set DelinHistoryCtrCC15

DelinHistoryCtrCC16

integer

get or set DelinHistoryCtrCC16

DelinHistoryCtrCC17

integer

get or set DelinHistoryCtrCC17

DelinHistoryCtrCC18

integer

get or set DelinHistoryCtrCC18

DelinHistoryCtrCC19

integer

get or set DelinHistoryCtrCC19

DelinHistoryCtrCC20

integer

get or set DelinHistoryCtrCC20

DelinHistoryCtrCC21

integer

get or set DelinHistoryCtrCC21

DelinHistoryCtrCC22

integer

get or set DelinHistoryCtrCC22

DelinHistoryCtrCC23

integer

get or set DelinHistoryCtrCC23

DelinHistoryCtrCC24

integer

get or set DelinHistoryCtrCC24

ReportHistoryCtrCC01

integer

Reported history on payment deliquency 1 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC02

integer

Reported history on payment deliquency 2 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC03

integer

Reported history on payment deliquency 3 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC04

integer

Reported history on payment deliquency 4 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC05

integer

Reported history on payment deliquency 5 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC06

integer

Reported history on payment deliquency 6 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC07

integer

Reported history on payment deliquency 7 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC08

integer

Reported history on payment deliquency 8 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC09

integer

Reported history on payment deliquency 9 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC10

integer

Reported history on payment deliquency 10 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC11

integer

Reported history on payment deliquency 11 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC12

integer

Reported history on payment deliquency 12 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC13

integer

Reported history on payment deliquency 13 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC14

integer

Reported history on payment deliquency 14 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC15

integer

Reported history on payment deliquency 15 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC16

integer

Reported history on payment deliquency 16 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC17

integer

Reported history on payment deliquency 17 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC18

integer

Reported history on payment deliquency 18 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC19

integer

Reported history on payment deliquency 19 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC20

integer

Reported history on payment deliquency 20 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC21

integer

Reported history on payment deliquency 21 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC22

integer

Reported history on payment deliquency 22 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC23

integer

Reported history on payment deliquency 23 Cycle ago Valid Values:Combo values

ReportHistoryCtrCC24

integer

Reported history on payment deliquency 24 Cycle ago Valid Values:Combo values

LastUpdDateCounterCC01

string

get or set LastUpdDateCounterCC01

LastUpdDateCounterCC02

string

get or set LastUpdDateCounterCC02

LastUpdDateCounterCC03

string

get or set LastUpdDateCounterCC03

LastUpdDateCounterCC04

string

get or set LastUpdDateCounterCC04

LastUpdDateCounterCC05

string

get or set LastUpdDateCounterCC05

LastUpdDateCounterCC06

string

get or set LastUpdDateCounterCC06

LastUpdDateCounterCC07

string

get or set LastUpdDateCounterCC07

LastUpdDateCounterCC08

string

get or set LastUpdDateCounterCC08

LastUpdDateCounterCC09

string

get or set LastUpdDateCounterCC09

LastUpdDateCounterCC10

string

get or set LastUpdDateCounterCC10

LastUpdDateCounterCC11

string

get or set LastUpdDateCounterCC11

LastUpdDateCounterCC12

string

get or set LastUpdDateCounterCC12

LastUpdDateCounterCC13

string

get or set LastUpdDateCounterCC13

LastUpdDateCounterCC14

string

get or set LastUpdDateCounterCC14

LastUpdDateCounterCC15

string

get or set LastUpdDateCounterCC15

LastUpdDateCounterCC16

string

get or set LastUpdDateCounterCC16

LastUpdDateCounterCC17

string

get or set LastUpdDateCounterCC17

LastUpdDateCounterCC18

string

get or set LastUpdDateCounterCC18

LastUpdDateCounterCC19

string

get or set LastUpdDateCounterCC19

LastUpdDateCounterCC20

string

get or set LastUpdDateCounterCC20

LastUpdDateCounterCC21

string

get or set LastUpdDateCounterCC21

LastUpdDateCounterCC22

string

get or set LastUpdDateCounterCC22

LastUpdDateCounterCC23

string

get or set LastUpdDateCounterCC23

LastUpdDateCounterCC24

string

get or set LastUpdDateCounterCC24

LastUpdUsrCounterCC01

string

get or set LastUpdUsrCounterCC01

LastUpdUsrCounterCC02

string

get or set LastUpdUsrCounterCC02

LastUpdUsrCounterCC03

string

get or set LastUpdUsrCounterCC03

LastUpdUsrCounterCC04

string

get or set LastUpdUsrCounterCC04

LastUpdUsrCounterCC05

string

get or set LastUpdUsrCounterCC05

LastUpdUsrCounterCC06

string

get or set LastUpdUsrCounterCC06

LastUpdUsrCounterCC07

string

get or set LastUpdUsrCounterCC07

LastUpdUsrCounterCC08

string

get or set LastUpdUsrCounterCC08

LastUpdUsrCounterCC09

string

get or set LastUpdUsrCounterCC09

LastUpdUsrCounterCC10

string

get or set LastUpdUsrCounterCC10

LastUpdUsrCounterCC11

string

get or set LastUpdUsrCounterCC11

LastUpdUsrCounterCC12

string

get or set LastUpdUsrCounterCC12

LastUpdUsrCounterCC13

string

get or set LastUpdUsrCounterCC13

LastUpdUsrCounterCC14

string

get or set LastUpdUsrCounterCC14

LastUpdUsrCounterCC15

string

get or set LastUpdUsrCounterCC15

LastUpdUsrCounterCC16

string

get or set LastUpdUsrCounterCC16

LastUpdUsrCounterCC17

string

get or set LastUpdUsrCounterCC17

LastUpdUsrCounterCC18

string

get or set LastUpdUsrCounterCC18

LastUpdUsrCounterCC19

string

get or set LastUpdUsrCounterCC19

LastUpdUsrCounterCC20

string

get or set LastUpdUsrCounterCC20

LastUpdUsrCounterCC21

string

get or set LastUpdUsrCounterCC21

LastUpdUsrCounterCC22

string

get or set LastUpdUsrCounterCC22

LastUpdUsrCounterCC23

string

get or set LastUpdUsrCounterCC23

LastUpdUsrCounterCC24

string

get or set LastUpdUsrCounterCC24

PaymentLastUpdateDateCounter1CycAgo

datetime

Last udpate date of payment for 01 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter2CycAgo

datetime

Last udpate date of payment for 02 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter3CycAgo

datetime

Last udpate date of payment for 03 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter4CycAgo

datetime

Last udpate date of payment for 04 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter5CycAgo

datetime

Last udpate date of payment for 05 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter6CycAgo

datetime

Last udpate date of payment for 06 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter7CycAgo

datetime

Last udpate date of payment for 07 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter8CycAgo

datetime

Last udpate date of payment for 08 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter9CycAgo

datetime

Last udpate date of payment for 09 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter10CycAgo

datetime

Last udpate date of payment for 10 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter11CycAgo

datetime

Last udpate date of payment for 11 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter12CycAgo

datetime

Last udpate date of payment for 12 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter13CycAgo

datetime

Last udpate date of payment for 13 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter14CycAgo

datetime

Last udpate date of payment for 14 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter15CycAgo

datetime

Last udpate date of payment for 15 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter16CycAgo

datetime

Last udpate date of payment for 16 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter17CycAgo

datetime

Last udpate date of payment for 17 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter18CycAgo

datetime

Last udpate date of payment for 18 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter19CycAgo

datetime

Last udpate date of payment for 19 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter20CycAgo

datetime

Last udpate date of payment for 20 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter21CycAgo

datetime

Last udpate date of payment for 21 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter22CycAgo

datetime

Last udpate date of payment for 22 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter23CycAgo

datetime

Last udpate date of payment for 23 cycle ago Valid Values: valid values Format: MM/DD/YYYY Example:12/20/2019

PaymentLastUpdateDateCounter24CycAgo

datetime

Last udpate date of payment for 24 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019

PaymentLastUpdatedUserCounter1CycAgo

string

Last udpated user of Payment 01 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User01

Allowable Values:

128

PaymentLastUpdatedUserCounter2CycAgo

string

Last udpated user of Payment 02 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User02

Allowable Values:

128

PaymentLastUpdatedUserCounter3CycAgo

string

Last udpated user of Payment 03 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User03

Allowable Values:

128

PaymentLastUpdatedUserCounter4CycAgo

string

Last udpated user of Payment 04 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User04

Allowable Values:

128

PaymentLastUpdatedUserCounter5CycAgo

string

Last udpated user of Payment 05 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User05

Allowable Values:

128

PaymentLastUpdatedUserCounter6CycAgo

string

Last udpated user of Payment 06 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User06

Allowable Values:

128

PaymentLastUpdatedUserCounter7CycAgo

string

Last udpated user of Payment 07 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User07

Allowable Values:

128

PaymentLastUpdatedUserCounter8CycAgo

string

Last udpated user of Payment 08 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User08

Allowable Values:

128

PaymentLastUpdatedUserCounter9CycAgo

string

Last udpated user of Payment 09 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User09

Allowable Values:

128

PaymentLastUpdatedUserCounter10CycAgo

string

Last udpated user of Payment 10 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User10

Allowable Values:

128

PaymentLastUpdatedUserCounter11CycAgo

string

Last udpated user of Payment 11 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User11

Allowable Values:

128

PaymentLastUpdatedUserCounter12CycAgo

string

Last udpated user of Payment 12 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User12

Allowable Values:

128

PaymentLastUpdatedUserCounter13CycAgo

string

Last udpated user of Payment 13 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User13

Allowable Values:

128

PaymentLastUpdatedUserCounter14CycAgo

string

Last udpated user of Payment 14 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User14

Allowable Values:

128

PaymentLastUpdatedUserCounter15CycAgo

string

Last udpated user of Payment 15 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User15

Allowable Values:

128

PaymentLastUpdatedUserCounter16CycAgo

string

Last udpated user of Payment 16 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User16

Allowable Values:

128

PaymentLastUpdatedUserCounter17CycAgo

string

Last udpated user of Payment 17 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User17

Allowable Values:

128

PaymentLastUpdatedUserCounter18CycAgo

string

Last udpated user of Payment 18 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User18

Allowable Values:

128

PaymentLastUpdatedUserCounter19CycAgo

string

Last udpated user of Payment 19 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User19

Allowable Values:

128

PaymentLastUpdatedUserCounter20CycAgo

string

Last udpated user of Payment 20 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User20

Allowable Values:

128

PaymentLastUpdatedUserCounter21CycAgo

string

Last udpated user of Payment 21 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User21

Allowable Values:

128

PaymentLastUpdatedUserCounter22CycAgo

string

Last udpated user of Payment 22 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User22

Allowable Values:

128

PaymentLastUpdatedUserCounter23CycAgo

string

Last udpated user of Payment 23 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User23

Allowable Values:

128

PaymentLastUpdatedUserCounter24CycAgo

string

Last udpated user of Payment 24 cycle ago Valid Values: A-Z, 0-9 Format: XXXXXX1 Example: User24

Allowable Values:

128

PaymentGeneratedHistoryCounter1CycAgo

integer

Delinquency Generated History Counter for previous 01 cycle Valid Values: Delinquency Buckets Format: 0-9 Example: 1

PaymentGeneratedHistoryCounter2CycAgo

integer

Delinquency Generated History Counter for previous 02 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter3CycAgo

integer

Delinquency Generated History Counter for previous 03 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter4CycAgo

integer

Delinquency Generated History Counter for previous 04 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter5CycAgo

integer

Delinquency Generated History Counter for previous 05 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter6CycAgo

integer

Delinquency Generated History Counter for previous 06 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter7CycAgo

integer

Delinquency Generated History Counter for previous 07 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter8CycAgo

integer

Delinquency Generated History Counter for previous 08 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter9CycAgo

integer

Delinquency Generated History Counter for previous 09 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter10CycAgo

integer

Delinquency Generated History Counter for previous 10 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter11CycAgo

integer

Delinquency Generated History Counter for previous 11 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter12CycAgo

integer

Delinquency Generated History Counter for previous 12 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter13CycAgo

integer

Delinquency Generated History Counter for previous 13 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter14CycAgo

integer

Delinquency Generated History Counter for previous 14 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter15CycAgo

integer

Delinquency Generated History Counter for previous 15 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter16CycAgo

integer

Delinquency Generated History Counter for previous 16 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter17CycAgo

integer

Delinquency Generated History Counter for previous 17 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter18CycAgo

integer

Delinquency Generated History Counter for previous 18 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter19CycAgo

integer

Delinquency Generated History Counter for previous 19 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter20CycAgo

integer

Delinquency Generated History Counter for previous 20 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter21CycAgo

integer

Delinquency Generated History Counter for previous 21 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter22CycAgo

integer

Delinquency Generated History Counter for previous 22 cycle Valid Values: 0-9 Format: xx

PaymentGeneratedHistoryCounter23CycAgo

integer

Delinquency Generated History Counter for previous 23 cycle Valid Values: 0-9 Format: xx

PaymentReportedHistoryCounter1CycAgo

integer

History Counter Reported for previous 01 cycle Valid Values: 1: 0 Payment Past Due (Current Account) 2: 30 to 59 Days Past Due 3: 60 to 89 Days Past Due 4: 90 to 119 Days Past Due 5: 120 to 149 Days Past Due 6: 150 to 179 Days Past Due 7: 180 or more Days Past Due 10: D = No Payment History available this month Format: 0-9 Example: 1

PaymentReportedHistoryCounter2CycAgo

integer

History Counter Reported for previous 02 cycle Valid Values: 1: 0 Payment Past Due (Current Account) 2: 30 to 59 Days Past Due 3: 60 to 89 Days Past Due 4: 90 to 119 Days Past Due 5: 120 to 149 Days Past Due 6: 150 to 179 Days Past Due 7: 180 or more Days Past Due 10: D = No Payment History available this month Format: 0-9 Example: 1

PaymentReportedHistoryCounter3CycAgo

integer

History Counter Reported for previous 03 cycle Valid Values: 1: 0 Payment Past Due (Current Account) 2: 30 to 59 Days Past Due 3: 60 to 89 Days Past Due 4: 90 to 119 Days Past Due 5: 120 to 149 Days Past Due 6: 150 to 179 Days Past Due 7: 180 or more Days Past Due 10: D = No Payment History available this month Format: 0-9 Example: 1

PaymentReportedHistoryCounter4CycAgo

integer

History Counter Reported for previous 04 cycle Valid Values: 1: 0 Payment Past Due (Current Account) 2: 30 to 59 Days Past Due 3: 60 to 89 Days Past Due 4: 90 to 119 Days Past Due 5: 120 to 149 Days Past Due 6: 150 to 179 Days Past Due 7: 180 or more Days Past Due 10: D = No Payment History available this month Format: 0-9 Example: 1

PaymentReportedHistoryCounter5CycAgo

integer

History Counter Reported for previous 05 cycle Valid Values: 1: 0 Payment