Account Details
You can use the CoreCard API to retrieve general account information, such as the primary currency code, the overlimit credit, various fees balances, the credit limit, the past due amount, the minimum payment due amount, the current balance, the statement format (i.e., physical, digital, or paused), the date the account was opened, the program ID, and the number of days in the cycle. You can obtain details of the available credit limit and cash credit limit using the API (see the GetAccountDetails API).
Additionally, you can add a status to the account for a specific time period. Once the manually applied status expires or another status is added, the account status will be updated.
You can use the API to obtain details of an account credit strategy. The account credit strategy determines whether the account has overlimit protection, how the overlimit protection is being used for various merchant category groups for card-present and card-not-present transactions. You can also obtain information about the past due days permitted to charge off the account.
You can perform a delinquency re-age on account to make it a regular, operational account. The delinquency re-age can either be executed as a full re-age or a partial re-age using the CoreCard API. The API also returns the delinquency history of a card account.
You can define various attributes on different plan segments, such as charging different interest rates and fees. You can use the CoreCard API to obtain or update the details of a plan segment.
You can manage fees such as interest, late fees, card fees, membership fees, message fees, overlimit fees, and service charges to be applied or waived for a certain period or permanently.
The CoreCard system also allows the creation of payment hold rules with different parameters and to obtain the hold payment details, such as the payment schedule ID, hold amount, payment post date and time, hold status, number of payments on hold, and the total amount of payment on hold. You can also use the API to release a payment from a hold status by providing an account number and the specific transaction ID.
You can use the CoreCard API to control compliance-related rule attributes to make your card program operational in a specific geographic location. For example, federal or state regulations such SCRA, MLA, and Reg O must be followed in order for a card program to be operational in the United States.
Get Extended Manual Status
Action: POST
Endpoint: /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 |
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 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"
}
],
"CurrencySymbol": null
}
}
}
Search Application
Action: POST
Endpoint: /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 |
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 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
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 |
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 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 All Accounts
Action: POST
Endpoint: /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 |
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 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 |
|
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": null,
"CustomerID": "167261",
"CardType": null,
"EmbossingManualStatus": null,
"EmbossingGeneratedStatus": null,
"OFACMatchedBy": null
}
]
}
}
}
Debit Card Management
Action: POST
Endpoint: /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 |
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 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
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 |
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 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"
}
]
}
}
}
Get Portfolio ID History
Action: POST
Endpoint: /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 |
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 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": "HighLineMerchant",
"ProductName": "ABC Patient Solutions Installment",
"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
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 |
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 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"
}
]
}
}
}
Reset Generated Status
Action: POST
Endpoint: /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 |
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 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
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 |
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 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
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 |
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 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": 5994
}
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: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter2CycAgo datetime |
Last udpate date of payment for 02 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter3CycAgo datetime |
Last udpate date of payment for 03 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter4CycAgo datetime |
Last udpate date of payment for 04 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter5CycAgo datetime |
Last udpate date of payment for 05 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter6CycAgo datetime |
Last udpate date of payment for 06 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter7CycAgo datetime |
Last udpate date of payment for 07 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter8CycAgo datetime |
Last udpate date of payment for 08 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter9CycAgo datetime |
Last udpate date of payment for 09 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter10CycAgo datetime |
Last udpate date of payment for 10 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter11CycAgo datetime |
Last udpate date of payment for 11 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter12CycAgo datetime |
Last udpate date of payment for 12 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter13CycAgo datetime |
Last udpate date of payment for 13 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter14CycAgo datetime |
Last udpate date of payment for 14 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter15CycAgo datetime |
Last udpate date of payment for 15 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter16CycAgo datetime |
Last udpate date of payment for 16 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter17CycAgo datetime |
Last udpate date of payment for 17 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter18CycAgo datetime |
Last udpate date of payment for 18 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter19CycAgo datetime |
Last udpate date of payment for 19 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter20CycAgo datetime |
Last udpate date of payment for 20 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter21CycAgo datetime |
Last udpate date of payment for 21 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter22CycAgo datetime |
Last udpate date of payment for 22 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
PaymentLastUpdateDateCounter23CycAgo datetime |
Last udpate date of payment for 23 cycle ago Valid Values: valid values Format: MMDDYYYY Example:12202019 |
|
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 |
Sample response body
{
"application/json": {
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"PayHistoryCtrCC01": 100,
"PayHistoryCtrCC02": 100,
"PayHistoryCtrCC03": 100,
"PayHistoryCtrCC04": 100,
"PayHistoryCtrCC05": 100,
"PayHistoryCtrCC06": 100,
"PayHistoryCtrCC07": 100,
"PayHistoryCtrCC08": 100,
"PayHistoryCtrCC09": 100,
"PayHistoryCtrCC10": 100,
"PayHistoryCtrCC11": 100,
"PayHistoryCtrCC12": 100,
"PayHistoryCtrCC13": 100,
"PayHistoryCtrCC14": 100,
"PayHistoryCtrCC15": 100,
"PayHistoryCtrCC16": 100,
"PayHistoryCtrCC17": 100,
"PayHistoryCtrCC18": 100,
"PayHistoryCtrCC19": 100,
"PayHistoryCtrCC20": 100,
"PayHistoryCtrCC21": 100,
"PayHistoryCtrCC22": 100,
"PayHistoryCtrCC23": 100,
"PayHistoryCtrCC24": 100,
"PaymentHistoryCounter1CycAgo": 100,
"PaymentHistoryCounter2CycAgo": 100,
"PaymentHistoryCounter3CycAgo": 100,
"PaymentHistoryCounter4CycAgo": 100,
"PaymentHistoryCounter5CycAgo": 100,
"PaymentHistoryCounter6CycAgo": 100,
"PaymentHistoryCounter7CycAgo": 100,
"PaymentHistoryCounter8CycAgo": 100,
"PaymentHistoryCounter9CycAgo": 100,
"PaymentHistoryCounter10CycAgo": 100,
"PaymentHistoryCounter11CycAgo": 100,
"PaymentHistoryCounter12CycAgo": 100,
"PaymentHistoryCounter13CycAgo": 100,
"PaymentHistoryCounter14CycAgo": 100,
"PaymentHistoryCounter15CycAgo": 100,
"PaymentHistoryCounter16CycAgo": 100,
"PaymentHistoryCounter17CycAgo": 100,
"PaymentHistoryCounter18CycAgo": 100,
"PaymentHistoryCounter19CycAgo": 100,
"PaymentHistoryCounter20CycAgo": 100,
"PaymentHistoryCounter21CycAgo": 100,
"PaymentHistoryCounter22CycAgo": 100,
"PaymentHistoryCounter23CycAgo": 100,
"PaymentHistoryCounter24CycAgo": 100,
"PaymentLastUpdateDateCounter1CycAgo": null,
"PaymentLastUpdateDateCounter2CycAgo": null,
"PaymentLastUpdateDateCounter3CycAgo": null,
"PaymentLastUpdateDateCounter4CycAgo": null,
"PaymentLastUpdateDateCounter5CycAgo": null,
"PaymentLastUpdateDateCounter6CycAgo": null,
"PaymentLastUpdateDateCounter7CycAgo": null,
"PaymentLastUpdateDateCounter8CycAgo": null,
"PaymentLastUpdateDateCounter9CycAgo": null,
"PaymentLastUpdateDateCounter10CycAgo": null,
"PaymentLastUpdateDateCounter11CycAgo": null,
"PaymentLastUpdateDateCounter12CycAgo": null,
"PaymentLastUpdateDateCounter13CycAgo": null,
"PaymentLastUpdateDateCounter14CycAgo": null,
"PaymentLastUpdateDateCounter15CycAgo": null,
"PaymentLastUpdateDateCounter16CycAgo": null,
"PaymentLastUpdateDateCounter17CycAgo": null,
"PaymentLastUpdateDateCounter18CycAgo": null,
"PaymentLastUpdateDateCounter19CycAgo": null,
"PaymentLastUpdateDateCounter20CycAgo": null,
"PaymentLastUpdateDateCounter21CycAgo": null,
"PaymentLastUpdateDateCounter22CycAgo": null,
"PaymentLastUpdateDateCounter23CycAgo": null,
"PaymentLastUpdateDateCounter24CycAgo": null,
"PaymentLastUpdatedUserCounter1CycAgo": null,
"PaymentLastUpdatedUserCounter2CycAgo": null,
"PaymentLastUpdatedUserCounter3CycAgo": null,
"PaymentLastUpdatedUserCounter4CycAgo": null,
"PaymentLastUpdatedUserCounter5CycAgo": null,
"PaymentLastUpdatedUserCounter6CycAgo": null,
"PaymentLastUpdatedUserCounter7CycAgo": null,
"PaymentLastUpdatedUserCounter8CycAgo": null,
"PaymentLastUpdatedUserCounter9CycAgo": null,
"PaymentLastUpdatedUserCounter10CycAgo": null,
"PaymentLastUpdatedUserCounter11CycAgo": null,
"PaymentLastUpdatedUserCounter12CycAgo": null,
"PaymentLastUpdatedUserCounter13CycAgo": null,
"PaymentLastUpdatedUserCounter14CycAgo": null,
"PaymentLastUpdatedUserCounter15CycAgo": null,
"PaymentLastUpdatedUserCounter16CycAgo": null,
"PaymentLastUpdatedUserCounter17CycAgo": null,
"PaymentLastUpdatedUserCounter18CycAgo": null,
"PaymentLastUpdatedUserCounter19CycAgo": null,
"PaymentLastUpdatedUserCounter20CycAgo": null,
"PaymentLastUpdatedUserCounter21CycAgo": null,
"PaymentLastUpdatedUserCounter22CycAgo": null,
"PaymentLastUpdatedUserCounter23CycAgo": null,
"PaymentLastUpdatedUserCounter24CycAgo": null,
"NumberOfMonthsWithBalance": 1,
"NumberOfMonthsWithPurchase": 1,
"LastSkipPymtDate": null,
"LastSkipPymtAmt": "0.0000",
"NumberOfSkipPayments": 0,
"DelinHistoryCtrCC01": 9,
"DelinHistoryCtrCC02": 9,
"DelinHistoryCtrCC03": 9,
"DelinHistoryCtrCC04": 9,
"DelinHistoryCtrCC05": 9,
"DelinHistoryCtrCC06": 9,
"DelinHistoryCtrCC07": 9,
"DelinHistoryCtrCC08": 9,
"DelinHistoryCtrCC09": 9,
"DelinHistoryCtrCC10": 9,
"DelinHistoryCtrCC11": 9,
"DelinHistoryCtrCC12": 9,
"DelinHistoryCtrCC13": 9,
"DelinHistoryCtrCC14": 9,
"DelinHistoryCtrCC15": 9,
"DelinHistoryCtrCC16": 9,
"DelinHistoryCtrCC17": 9,
"DelinHistoryCtrCC18": 9,
"DelinHistoryCtrCC19": 9,
"DelinHistoryCtrCC20": 9,
"DelinHistoryCtrCC21": 9,
"DelinHistoryCtrCC22": 9,
"DelinHistoryCtrCC23": 9,
"DelinHistoryCtrCC24": 9,
"ReportHistoryCtrCC01": 9,
"ReportHistoryCtrCC02": 9,
"ReportHistoryCtrCC03": 9,
"ReportHistoryCtrCC04": 9,
"ReportHistoryCtrCC05": 9,
"ReportHistoryCtrCC06": 9,
"ReportHistoryCtrCC07": 9,
"ReportHistoryCtrCC08": 9,
"ReportHistoryCtrCC09": 9,
"ReportHistoryCtrCC10": 9,
"ReportHistoryCtrCC11": 9,
"ReportHistoryCtrCC12": 9,
"ReportHistoryCtrCC13": 9,
"ReportHistoryCtrCC14": 9,
"ReportHistoryCtrCC15": 9,
"ReportHistoryCtrCC16": 9,
"ReportHistoryCtrCC17": 9,
"ReportHistoryCtrCC18": 9,
"ReportHistoryCtrCC19": 9,
"ReportHistoryCtrCC20": 9,
"ReportHistoryCtrCC21": 9,
"ReportHistoryCtrCC22": 9,
"ReportHistoryCtrCC23": 9,
"ReportHistoryCtrCC24": 9,
"LastUpdDateCounterCC01": null,
"LastUpdDateCounterCC02": null,
"LastUpdDateCounterCC03": null,
"LastUpdDateCounterCC04": null,
"LastUpdDateCounterCC05": null,
"LastUpdDateCounterCC06": null,
"LastUpdDateCounterCC07": null,
"LastUpdDateCounterCC08": null,
"LastUpdDateCounterCC09": null,
"LastUpdDateCounterCC10": null,
"LastUpdDateCounterCC11": null,
"LastUpdDateCounterCC12": null,
"LastUpdDateCounterCC13": null,
"LastUpdDateCounterCC14": null,
"LastUpdDateCounterCC15": null,
"LastUpdDateCounterCC16": null,
"LastUpdDateCounterCC17": null,
"LastUpdDateCounterCC18": null,
"LastUpdDateCounterCC19": null,
"LastUpdDateCounterCC20": null,
"LastUpdDateCounterCC21": null,
"LastUpdDateCounterCC22": null,
"LastUpdDateCounterCC23": null,
"LastUpdDateCounterCC24": null,
"LastUpdUsrCounterCC01": null,
"LastUpdUsrCounterCC02": null,
"LastUpdUsrCounterCC03": null,
"LastUpdUsrCounterCC04": null,
"LastUpdUsrCounterCC05": null,
"LastUpdUsrCounterCC06": "",
"LastUpdUsrCounterCC07": "",
"LastUpdUsrCounterCC08": "",
"LastUpdUsrCounterCC09": "",
"LastUpdUsrCounterCC10": "",
"LastUpdUsrCounterCC11": "",
"LastUpdUsrCounterCC12": "",
"LastUpdUsrCounterCC13": "",
"LastUpdUsrCounterCC14": "",
"LastUpdUsrCounterCC15": "",
"LastUpdUsrCounterCC16": "",
"LastUpdUsrCounterCC17": "",
"LastUpdUsrCounterCC18": "",
"LastUpdUsrCounterCC19": "",
"LastUpdUsrCounterCC20": "",
"LastUpdUsrCounterCC21": "",
"LastUpdUsrCounterCC22": "",
"LastUpdUsrCounterCC23": "",
"LastUpdUsrCounterCC24": ""
}
}
}
Get Payment Schedule
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetPaymentSchedule
Use this API to obtain all payment schedules added into the system for a certain 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 |
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 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:XXXXXX Example:123654 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
|
CardNumber string Conditional |
Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654789654 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
|
ScheduleID integer Optional |
Unique identifier for Schedule Payment. |
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,
"AdminNumber": 167550,
"AccountNumber": "8110000000000125",
"CardNumber": null,
"ScheduleID": null
}
Response fields detail
| Fields | Description |
|---|---|
|
PaymentScheduleList array |
PaymentScheduleList |
|
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 |
Sample response body
{
"application/json": {
"Message": "Payment Schedules returned successfully.",
"Status": true,
"ErrorCode": "ERR01035",
"ResponseData": {
"PaymentScheduleList": [
{
"ScheduleID": 4907,
"ScheduleStatus": 1,
"MethodName": 4039,
"PaymentType": 0,
"Frequency": 1,
"SpecificDay": "10",
"DateOfPayment": "03/15/2020 00:00:00",
"NextPaymentDate": "03/31/2020 00:00:00",
"PaymentAmount": 1020.0,
"PaymentPosted": 0,
"UserIdCreatedOn": "03/15/2020 00:00:00",
"BankAccountType": "1",
"BAMLast4Digit": "0821",
"PaymentMode": 0,
"XDaysBeforePaymentDueDate": 0,
"PaymentReferenceId": null,
"UserIdCreated": null,
"UserIdDeletedOn": null,
"UserIdDeleted": null,
"BankName": "JPMorgan Chase",
"ApplicantType": "Applicant"
}
],
"ResponseID": null
}
}
}
Get Payment Schedule Transaction
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetPaymentScheduleTransaction
Use this API to get transactions of each payment schedule using card number or admin number or account number. API fetches out the details such as return reason code for ACH payment reversal transactions, payment method, mode of payment, reversal date, and other details related to payment allocation plans.
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 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 |
|
CardNumber string Conditional |
Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/CardNumber/AccountNumber is required. Allowable Values: 19 |
|
ScheduleID integer Conditional |
Unique identifier for Schedule Payment. Valid Values: 0-9 Format:XXXXX Example:25874 Condition: Either ScheduleID or Page, Limit is required. |
|
Action integer Optional |
If Action is blank or Null then all transaction will be returned. 1 = All 2 = Successful 3 = Fail 4= Skipped Valid Values: 1,2,3, Example:1 |
|
Page integer Conditional |
Use to display transactions for a particular page. It's always be greater than or equal To 1 Valid Values: 0-9 Format:XXX Example:1 Condition : This is mandatory if 'ScheduleID is' not supplied. |
|
Limit integer Conditional |
Display number of transactions in a page. Valid Values: 0-9 Format:XXX Example:50 Condition : This is mandatory if 'ScheduleID is' not supplied. |
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,
"CardNumber": null,
"AdminNumber": 167550,
"AccountNumber": "8110000000000125",
"ScheduleID": null,
"Action": null,
"Page": null,
"Limit": null
}
Response fields detail
| Fields | Description |
|---|---|
|
TransactionList array |
TransactionList |
|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Example:7485122 Allowable Values: 19 |
|
TotalNumberOfTxns integer |
Total number of transactions in the response. |
Sample response body
{
"application/json": {
"Message": "Payment schedule transaction(s) information returned successfully.",
"Status": true,
"ErrorCode": "ERR01034",
"ResponseData": {
"TransactionList": [
{
"TransactionID": 157878754548754,
"PostedDate": "03/15/2020 00:00:00",
"TransactionAmount": 152.0,
"Description": null,
"PostingReference": "1",
"PaymentStatus": "Paid",
"ReturnReasonCode": null,
"ReversalTranid": null,
"ReversalDate": null,
"ScheduleID": null,
"BankName": "JPMorgan Chase",
"BankAccountType": "1",
"BAMLast4Digit": "0821",
"Frequency": 1,
"ExternalErrorMessage": null,
"PaymentReferenceId": null,
"PaymentMode": "0",
"RequestID": "1452"
}
],
"ResponseID": null,
"TotalNumberOfTxns": 10
}
}
}
Get Self-service Payment History
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetSSPaymentHistory
Use this API to retrieve a record of payments made through the Self-service portal. Payment records are fetched using a date range. Each payment record contains information such as the Payment date and Amount.
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 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 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
|
PaymentFromDate datetime Mandatory |
Starting date of Payment search. Used as a criteria for Payment History Filter. Valid Values:0-9 Format:MM/DD/YYYY Example:02/20/2020 |
|
PaymentToDate datetime Mandatory |
End date of Payment search. Used as a criteria for Payment History Filter. Valid Values:0-9 Format:MM/DD/YYYY Example:02/20/2020 |
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": 129414,
"PaymentFromDate": "01/01/2017 00:00:00",
"PaymentToDate": "01/31/2017 00:00:00"
}
Response fields detail
| Fields | Description |
|---|---|
|
ListGetSSPaymentHistory array |
Get or Set lstGetSSPaymentHistory |
Sample response body
{
"application/json": {
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ListGetSSPaymentHistory": [
{
"PaymentDate": "01/17/2017 19:24:12",
"Amount": 36.0,
"PaymentFrom": "Manual Payment by Issuer"
}
]
}
}
}
Search Account
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/SearchAccount
Use this API to locate or search a card account in the CoreCARD platform. This search may be done using the cardholder's registered personal or contact or ID information, account information, or type of account or applicant. This API returns details such as account ID, cardholder name, account status, account current balance, and OTB for each matching record.
Note
You should use as many possible search parameters to get refined and suitable search results. In case multiple search records are located, then the API would return you all the records however you should use batch size in input to fetch the required top search results to improve the API performance.
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 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 |
Debtor File # or Client Account # Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
CardNumber string Conditional |
Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
|
CompanyNumber string Conditional |
Company Number Valid Values: 0-9 Format:XXXX Example:1234 Allowable Values: 7 |
|
ApplicationNumber int64 Conditional |
Unique Number generated for the Account creation Application . Valid Values:0-9 Example:8002201421 |
|
SearchByCoApplicant string Conditional |
Flag to decide if Search can be perform by CoApplicant or not. Valid Values: 0 and 1 Allowable Values: 2 |
|
CorporateAccountNumber string Conditional |
Corporate Account Number Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037 Allowable Values: 19 |
|
CardNumberLast4Digits string Conditional |
Last 4 digits of card number Valid Values:0-9 Format:XXXX Example:1234 Allowable Values: 4 |
|
MerchantNumber integer Conditional |
Merchant Number which is assgined to a Merchant. Valid Values- 0-9 Format:XXXXXX Example:11642 |
|
FirstName string Conditional |
Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1 Allowable Values: 50 |
|
LastName string Conditional |
Card holder's last name. Valid Values:A-Z Format:XXXXX Example:Smith Allowable Values: 80 |
|
EmailID string Conditional |
Card holder Email ID Format: XXX@xx.com Example:ABC@gmail.com |
|
DateOfBirth datetime Conditional |
Card Holder's Date of Birth Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 |
|
WorkPhoneNumber string Conditional |
Card holder Work phone number Valid Values:0-9 Format:XXXXXXXXXXX Example:5678909876 Allowable Values: 19 |
|
MobilePhoneNumber string Conditional |
Mobile Phone Number Valid Values:0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 15 |
|
HomePhoneNumber string Conditional |
Card holder Home Phone number Valid Values:0-9 Format:XXXXXXXXXX Example:7895463214 Allowable Values: 20 |
|
SSNLast4Digits string Conditional |
Card holder's last four digit of SSN Valid Values:1120 Format:XXXX Example:1120 Allowable Values: 4 |
|
TransactionID int64 Conditional |
Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789 |
|
SecondaryIDNumber string Conditional |
get or set SecondaryIdNumber Allowable Values: 128 |
|
CustomerID integer Conditional |
Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Allowable Values: 25 |
|
CompanyName string Conditional |
Company Name Valid Values:A-Z,0-9 Format:XXXXXX Example:ABC Allowable Values: 40 |
|
InvoiceNumber string Conditional |
Incoice Number for Transaction Valid Values:0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 28 |
|
CustomerType string Conditional |
This tag reflects the customer type, like Individual, organisation etc Valid Values: 01- Individual 02- Organization 07- Owning Partner 08- Partner Store 09- Purged 10- Register Example: 01 Allowable Values: 5 |
|
AccountType string Conditional |
Type of Account / Credit Report Details Account Type Valid Values: 0-Company 1-Cardholder 2-Holding Account 3-Relationship Allowable Values: 2 |
|
PostalCode string Conditional |
Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Allowable Values: 9 |
|
AddressLine1 string Conditional |
Debtor Address Line 1 Valid Values:A-Z, 0-9 Example:123 HWY Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) Allowable Values: 50 |
|
AddressLine2 string Conditional |
Debtor Address Line 2 Valid Values:A-Z,0-9 Example:Park Avenue Condition:This is mandatory only when HoldEmbossing tag value is 0(NO) and Country selected as Non-US. Allowable Values: 50 |
|
City string Conditional |
Debtor City Example:Los Angeles Condition: CBR" Allowable Values: 25 |
|
State string Conditional |
State of the card holder address. Format:XXXXX Example: MO Allowable Values: 3 |
|
Country string Conditional |
Country name of the Card holder's address Example:USA Allowable Values: 3 |
|
ClientID integer Conditional |
get or set ClientID |
|
ProductID integer Conditional |
Product ID Valid Values:0-9 Format:XXXX Example:1234 |
|
StoreID integer Conditional |
Store ID Valid Values:XXX Format:0-9 Example:1234 |
|
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 |
|
ReferenceID string |
get or set ReferenceID Allowable Values: 64 |
|
SearchByCosigner string Optional |
Flag to decide if search can be performed by cosigner. Valid Values: 0 and 1 Allowable Values: 2 |
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": "6000000200000013",
"AdminNumber": null,
"CompanyNumber": null,
"ApplicationNumber": null,
"SearchByCoApplicant": null,
"CorporateAccountNumber": null,
"CardNumberLast4Digits": "4959",
"MerchantNumber": null,
"FirstName": null,
"LastName": null,
"EmailID": null,
"DateOfBirth": null,
"WorkPhoneNumber": null,
"MobilePhoneNumber": null,
"HomePhoneNumber": null,
"SSNLast4Digits": null,
"TransactionID": null,
"SecondaryIDNumber": null,
"CustomerID": null,
"CompanyName": null,
"InvoiceNumber": null,
"CustomerType": null,
"AccountType": null,
"PostalCode": null,
"AddressLine1": null,
"AddressLine2": null,
"City": null,
"State": null,
"Country": null,
"ClientID": null,
"ProductID": null,
"StoreID": null,
"BatchSize": 100,
"PageIndex": null,
"ReferenceID": null,
"SearchByCosigner": null
}
Response fields detail
| Fields | Description |
|---|---|
|
SearchResult array |
This tag refer to the any search list . |
Sample response body
{
"application/json": {
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"SearchResult": [
{
"AccountID": 167413,
"ClientName": "ABC_Bank_CAD",
"ProductName": "Avidia Bank_CAD",
"CustomerID": "167252",
"AccountNumber": "6000000200000013",
"FirstName": null,
"LastName": null,
"AccountManualStatus": "Active",
"CurrentBalance": 0.0,
"CompanyName": "Ch1",
"CompanyNumber": "0000111",
"CorporateAccountNumber": "2113456325678121",
"AccountGeneratedStatus": "Active",
"PrimaryCurrencyCode": "124",
"ApplicationNumber": 0,
"IsCoApplicant": "No",
"OpenToBuy": "10000.0000",
"CosignerFirstName": null,
"CosignerLastName": null
}
]
}
}
}
Update Co-applicant Info
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdateCoApplicantInfo
Use this API to add or update co-applicant details, such as name, address, and contact information, in an existing customer record.
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 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 |
|
CustomerID string Conditional |
Used to identify, for which Customer Co-Applicant need to be udpated. Valid Values: 0-9 Format: XXXXX Example:12345 Condition: At least one of CustomerID\Account Number is required. Allowable Values: 19 |
|
CoApplicantTitle string Optional |
Co-Applicant’s Title Allowable Values: 10 |
|
CoApplicantFirstName string Optional |
Co-Applicant’s First Name Valid Values: A- Z Format: Example: John Allowable Values: 40 |
|
CoApplicantMiddleName string Optional |
Co-Applicant’s middle name Valid Values: A-Z Example: LEE Allowable Values: 40 |
|
CoApplicantLastName string Optional |
Co-Applicant’s last name Valid Values: A-Z Example:Smith Allowable Values: 40 |
|
CoApplicantDateOfBirth datetime Optional |
Co-Applicant’s date of birth Format: MM/DD/YYYY Example: 01/01/1990 |
|
CoApplicantSurnameSuffix string Optional |
Co-Applicant’s surname suffix Valid Values:Sr / Jr Example:SR Allowable Values: 5 |
|
CoApplicantMarritalStatus string Optional |
Co-Applicant’s marrital status Example:Married,Single, Divorced Allowable Values: 19 |
|
CoApplicantGender string Optional |
Co-Applicant’s gender Example: Male, Female Allowable Values: 5 |
|
CoApplicantAddressLine1 string Optional |
Co-Applicant’s Address line 1 Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
|
CoApplicantAddressLine2 string Optional |
Co-Applicant’s Address line 2 Example:Park Avenue Allowable Values: 50 |
|
CoApplicantCity string Optional |
Co-Applicant’s city Example:Los Angeles Allowable Values: 40 |
|
CoApplicantState string Conditional |
Co-Applicant’s state Allowable Values: 5 |
|
CoApplicantPostalCode string Optional |
Postal code of the CoApplicant address. Format: XXXXX Example:46077 Allowable Values: 10 |
|
CoApplicantCountry string Optional |
CoApplicant's Country Allowable Values: 5 |
|
CoApplicantResidenceType string Optional |
Co-Applicant’s residence type Valid Values: Own Rent Other Owns or is buying a home Rents or leases a home Does not rent or own Board Example: own Allowable Values: 50 |
|
CoApplicantBadAddress integer Optional |
Flag for Bad Address Valid Values: 0, 1 Format: x Example: 1 |
|
CoApplicantHomePhoneNumber string Optional |
Co-Applicant’s home phone number Valid Values: 0-9 Format: XXXXXXXXXX Example: 7896541236 Allowable Values: 20 |
|
CoApplicantMobilePhoneNumber string Optional |
Co-Applicant’s Mobile number Allowable Values: 20 |
|
CoApplicantEmailID string Optional |
Co-Applicant’s email id Valid Values: 0-9 Format: XXXXXXXXXX Example: 7896541236 Allowable Values: 254 |
|
CoApplicantWorkPhoneNUmber string Optional |
Co-Applicant’s work phone number Valid Values: 0-9 Format: XXXXXXXXXX Example:7896541236 Allowable Values: 20 |
|
CoApplicantMobileCarrier string |
Co-Applicant’s mobile carrier name. Example: BSNL Allowable Values: 40 |
|
CoApplicantFaxNumber string Optional |
CoApplicant's Fax number Valid Values: 0-9 Format: xxxxx Example: 12548795541 Allowable Values: 15 |
|
CoApplicantOtherPhoneNumber string Optional |
CoApplicant's Other Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541 Allowable Values: 15 |
|
CoApplicantCreditFilePhone string Optional |
CoApplicant's Credit File Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541 Allowable Values: 15 |
|
CoApplicantAlternatePhoneNumber string Optional |
CoApplicant's Alternate Phone number Valid Values: 0-9 Format: xxxxx Example: 12548795541 Allowable Values: 15 |
|
OptOutForEmailMarketing integer Optional |
Flag to Opt out for email marketing Valid Values: 0,1 Format: x Example: 1 |
|
CoApplicantOptOutTextMarketingHomePhoneNUM integer Optional |
Option for user to opt out for text marketing message on Home phone number. Valid Values:0-1 Format:X Example: 1 |
|
CoApplicantOptOutTextMarketingWorkPhoneNUM integer Optional |
Option for user to opt out for text marketing message on work phone number. Valid Values:0-1 Format:X Example: Y/N |
|
CoApplicantBadHomePhoneNUM integer Optional |
Bad phone flag for Home Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadMobileNUM integer Optional |
Bad phone flag for mobile Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadWorkPhoneNUM integer Optional |
Bad phone flag for work Phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallHomePhoneNUM integer Optional |
Do not call flag for Home Phone Number Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallMobileNUM integer Optional |
Do not call flag for Mobile Phone Number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallWorkPhoneNUM integer Optional |
Do not call flag for work Phone Number Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantOptOutTextMarketingMobileNUM integer Optional |
Flag to mark opt out text marketing Valid Values: 0,1 Format: x Example: 1 |
|
CoApplicantOptOutTextMarketingOtherPhoneNUM integer Optional |
Flag to mark opt out text marketing for other phone number. Valid Values: 0, 1 Format: x Example: 1 |
|
CoApplicantOptOutTextMarketingCreditFilePhone integer Optional |
Flag to mark opt out text marketing for credit file phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantOptOutTextMarketingAlternatePhone integer Optional |
Flag to mark opt out text marketing for alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadFaxNumber integer Optional |
Flag to mark bad for fax number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadOtherPhoneNUM integer Optional |
Flag to mark bad for other phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadCreditFilePhone integer Optional |
Flag to mark bad for credit file phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBadAlternatePhone integer Optional |
Flag to mark bad for alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallFaxNumber integer Optional |
Flag for do not call at Fax Number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallOtherPhoneNUM integer Optional |
Flag for do not call at other phone Valid Values: 0, 1 Format: x Example: 1 |
|
CoApplicantDoNotCallCreditFilePhone integer Optional |
Flag for do not call at Credit File Phone. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDoNotCallAlternatePhone integer Optional |
Flag for do not call at Alternate phone number. Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantBankruptcy integer Optional |
Flag to indicate Bankruptcy Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantThreePDM integer Optional |
Flag to indicate Third party debt management Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantDeceased integer Optional |
Flag to indicate Co applicant is deceased. Valid Values: 0,1 Format: x Example: 0- No, 1 - Yes |
|
CoApplicantCeaseandDesist integer Optional |
Flag to indicate co applicant is Cease And Desist Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
|
CoApplicantMaritalStatus string Optional |
Co-Applicant’s marital status Valid Values: 0 - 6 Format: x Example: 1 = Married, 2 = Single, 3 = Divorced, 4 = Seperated, 5 = Common Law, 6 = Unknown Allowable Values: 2 |
|
CoApplicantOptOutofEmailMarketing integer Optional |
Flag to Opt out for email marketing Valid Values: 0,1 Format: x Example: 1 |
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,
"CustomerID": "8422",
"CoApplicantTitle": "01",
"CoApplicantFirstName": "Rishabh",
"CoApplicantMiddleName": "Kumar",
"CoApplicantLastName": "Maheshwari",
"CoApplicantDateOfBirth": "03/30/1991 00:00:00",
"CoApplicantSurnameSuffix": null,
"CoApplicantMaritalStatus": "2",
"CoApplicantGender": "1",
"CoApplicantAddressLine1": "Address123",
"CoApplicantAddressLine2": "Add234",
"CoApplicantCity": "Bhopal",
"CoApplicantState": "AL",
"CoApplicantPostalCode": "485214",
"CoApplicantCountry": "US",
"CoApplicantResidenceType": "Own",
"CoApplicantBadAddress": null,
"CoApplicantHomePhoneNumber": "1547852963",
"CoApplicantMobilePhoneNumber": "8821826125",
"CoApplicantEmailID": "rish077maheshwari@gmail.com",
"CoApplicantWorkPhoneNUmber": "16733858555",
"CoApplicantMobileCarrier": "txt.att.net",
"CoApplicantFaxNumber": null,
"CoApplicantOtherPhoneNumber": null,
"CoApplicantCreditFilePhone": null,
"CoApplicantAlternatePhoneNumber": null,
"CoApplicantOptOutofEmailMarketing": null,
"CoApplicantOptOutTextMarketingHomePhoneNUM": 0,
"CoApplicantOptOutTextMarketingWorkPhoneNUM": 0,
"CoApplicantBadHomePhoneNUM": null,
"CoApplicantBadMobileNUM": null,
"CoApplicantBadWorkPhoneNUM": null,
"CoApplicantDoNotCallHomePhoneNUM": null,
"CoApplicantDoNotCallMobileNUM": null,
"CoApplicantDoNotCallWorkPhoneNUM": null,
"CoApplicantOptOutTextMarketingMobileNUM": null,
"CoApplicantOptOutTextMarketingOtherPhoneNUM": null,
"CoApplicantOptOutTextMarketingCreditFilePhone": null,
"CoApplicantOptOutTextMarketingAlternatePhone": null,
"CoApplicantBadFaxNumber": null,
"CoApplicantBadOtherPhoneNUM": null,
"CoApplicantBadCreditFilePhone": null,
"CoApplicantBadAlternatePhone": null,
"CoApplicantDoNotCallFaxNumber": null,
"CoApplicantDoNotCallOtherPhoneNUM": null,
"CoApplicantDoNotCallCreditFilePhone": null,
"CoApplicantDoNotCallAlternatePhone": null,
"CoApplicantBankruptcy": 0,
"CoApplicantThreePDM": 0,
"CoApplicantDeceased": 0,
"CoApplicantCeaseandDesist": 0
}
Response fields detail
| Fields | Description |
|---|
Sample response body
{
"application/json": {
"Message": "Profile has been updated successfully",
"Status": true,
"ErrorCode": "ERR01039",
"ResponseData": null
}
}
Update Portfolio ID
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdatePortfolioID
Use this API to update the portfolio ID of 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 |
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. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
PortfolioID string Mandatory |
Portfolio Id assigned on account Valid Values: Valid Portfolio ID value Format: XXXX Example: Midland Condition: This ID must be amongst the ID existing for the Institution (List received in Response of GetPortfolioIDMapping API) Allowable Values: 50 |
|
ApplicationVersion string Optional |
This Tag reflects the Application Version. Valid Values: 0-9 Example:2.0 Allowable Values: 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 |
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 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. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
PortfolioID string Mandatory |
Portfolio Id assigned on account Valid Values: Valid Portfolio ID value Format: XXXX Example: Midland Condition: This ID must be amongst the ID existing for the Institution (List received in Response of GetPortfolioIDMapping API) Allowable Values: 50 |
|
ApplicationVersion string Optional |
This Tag reflects the Application Version. Valid Values: 0-9 Example:2.0 Allowable Values: 3 |
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,
"AdminNumber": null,
"AccountNumber": "8000000000000011",
"PortfolioID": "ha12",
"ApplicationVersion": null
}
Response fields detail
| Fields | Description |
|---|---|
|
PlanSegmentID string |
Plan Segment ID for an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 10 |
|
InvoiceNumber string |
Incoice Number for Transaction. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 28 |
|
CollateralID string |
Collateral ID of an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:632563 Allowable Values: 10 |
|
EffectiveDate datetime |
This tag reflects the effective date of trnsaction Format:MMDDYYYY Example:01202020 |
|
ReasonCode integer |
Reason Code field for Error or Success of API. Valid Values:1/0 Format:X Example : 1,0 |
|
Memo string |
Note for each erroneous input. Two letter code Valid Values:A-Z,0-9 Format:ZZ Example:12. Allowable Values: 100 |
|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200 Allowable Values: 15 |
|
PlanSegmentID string |
Plan Segment ID for an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 10 |
|
InvoiceNumber string |
Incoice Number for Transaction. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757 Allowable Values: 28 |
|
CollateralID string |
Collateral ID of an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:632563 Allowable Values: 10 |
|
EffectiveDate datetime |
This tag reflects the effective date of trnsaction Format:MMDDYYYY Example:01202020 |
|
ReasonCode integer |
Reason Code field for Error or Success of API. Valid Values:1/0 Format:X Example : 1,0 |
|
Memo string |
Note for each erroneous input. Two letter code Valid Values:A-Z,0-9 Format:ZZ Example:12. Allowable Values: 100 |
|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200 Allowable Values: 15 |
Sample response body
{
"application/json": {
"Message": "Collateral ID Updated Successfully.",
"Status": true,
"ErrorCode": "0",
"ResponseData": {
"PlanSegmentID": "101340",
"InvoiceNumber": "170116014716699",
"CollateralID": "ha12",
"EffectiveDate": "01/16/2017 00:00:00",
"ReasonCode": 1,
"Memo": "Collateral ID Updated Successfully",
"ResponseID": "56792591"
}
}
}
Reset Self-service Password
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/SSResetPassword
If a cardholder forgets the self-service account login password, the API can generate a new default password to allow the cardholder to log in to the self-service portal and reset the password.
Note
The CoreCARD system notifies the cardholder to change the password on the first login attempt of a self-service portal.
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. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one account identifier is required. |
|
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
|