Account Control Parameters
Account control parameters in the CoreCard system determine how the account functions. These account control parameters may be configured to perform any monetary or non-monetary card operation.
You can use the API to retrieve account control attributes such as fee calculation, minimum payment amount calculation, and total due calculation. You can also use APIs to view the following:
Billing Cycle: Retrieve details like remaining days in the billing cycle, a billing cycle amount lodged in the dispute system, the name of the billing table, and current balance.
Statement Production: Using the statement date, retrieve details like credit limit, amount past due, charge amounts, current balances, previous balances, due dates, payment and credit details, the address to which the statement is mailed, disputed amounts, minimum due payment amounts, and current due amounts.
Manage Network Detail
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdateDeleteNetworkDetail
Use this API to delete or update an existing network attribute.
Note
If an existing network has an active merchant mapping on the network, then such a network cannot be deleted.
Request fields detail
| Fields | Description |
|---|---|
|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
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 |
|
DecisionFlag integer Mandatory |
Decision Flag must accept two values '0' and '1' If User Inputs '0' then the API must update the Network Details Inputted If User Inputs '1' then the API must delete the Network Details Inputted Valid Values: 0, 1 Example: 0 - Update, 1 - Delete |
|
NetworkID integer Mandatory |
On The basis of the Inputted Network ID, the Network Details will be Updated or Deleted depending on the 'Decision Flag' Valid Values: 0-9 Example: 12345 |
|
NetworkName string Conditional |
Name of the Network If in Decision Flag is '0' then it is Mandatory If in Decision Flag is '1' then it is Optional Allowable Values: 50 |
|
NetworkDescription string Optional |
Input Network Description to be Updated Allowable Values: 200 |
Sample request body
{
"Source": "WEB",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"DecisionFlag": null,
"NetworkID": 1001,
"NetworkName": "Network_1 Updated",
"NetworkDescription": "Desc Updated"
}
Response fields detail
| Fields | Description |
|---|
Sample response body
{
"application/json": {
"Message": "Network updated successfully",
"Status": true,
"ErrorCode": "ERR01181",
"ResponseData": null
}
}
Get Regulation Parameters
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetRegulationParameters
Use this API service to get details of the SCRA and reservist details which are applied on a card account. Account ID is a mandatory field to provide in the request of this API which fetches out the details of the Applicant or Co-Applicant or Co-signer benefits start date, end date, and a number of cycles reservist benefit availed on the card account.
Request fields detail
| Fields | Description |
|---|---|
|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
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": 161563
}
Response fields detail
| Fields | Description |
|---|---|
|
ReservistHistory array |
reservistHistory list |
Sample response body
{
"application/json": {
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ReservistHistory": [
{
"ApplicantType": "Applicant",
"ReservistBenefitStartDate": "06/05/2020 00:00:00",
"ReservistBenefitEndDate": "07/31/2020 23:59:57",
"ReservistServiceEndDate": "06/30/2020 00:00:00",
"ReservistBenefitEndNoticeDate": null,
"ReservistBenefitUsedYTDOnCustomer": 0
},
{
"ApplicantType": "Cosigner",
"ReservistBenefitStartDate": "07/05/2020 00:00:00",
"ReservistBenefitEndDate": "09/23/2020 23:59:57",
"ReservistServiceEndDate": "12/12/2020 00:00:00",
"ReservistBenefitEndNoticeDate": null,
"ReservistBenefitUsedYTDOnCustomer": 0
}
]
}
}
}
Update Account Control Parameters
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdateAcctControlParameters
Use this API to update base segment account control parameters, such as billing table name, ratification method, payment parameters, cash advance parameters, cash limit method, cash limit percentage, and cash limit 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 |
|
AccountID integer Mandatory |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 |
|
RatificationMethod1 integer Optional |
Identifies the ratification method. Valid Values: 0 = Normal 1 = Grandfathered 2 = Statement Example: 0 |
|
PaymentType integer Optional |
Method with which Payment is billed. Valid Values: 0 = Bill Balance 1 = Bill Fixed Amount 2 = Bill Fixed Percent 3 = Bill Invoice 4 = Bill Fixed Percent Of High Balance Example: 0 = Bill Balance |
|
FixedPaymentAmount decimal Conditional |
Fixed amount define for Bill Fixed amount payment type. Valid Values: 0-9 Format: XX.XX Example: 150.50 Condition: This field is mandatory when Payment type is Bill Fixed amount. |
|
FixedPaymentPercentage decimal Conditional |
Percent of principal define for Bill Fix Percent payment type. Valid Values: 0-9 Example: 150.50 Condition: This field is mandatory when Payment type is Bill Fixed Percent. |
|
PaymentLevel integer Optional |
Define the level of Payment terms calculation. Valid Values: 0 = Account 1 = Plan 2 = Combined Example: 1 |
|
PaymentHoldSkipCheck integer Optional |
Flag to not check payment on hold parameter for the account. Valid Values: 0 = Unchecked, 1= Checked(system will not check payment on hold parameters for this account) Example: 1 Condition: Default value would be 0 |
|
EligibleForAutoSkipPaymentOpt integer Optional |
Define if Account is Eligible for Automatic skip of payment. Valid Values: 0 = Not Eligible 1 = Eligible |
|
CashLimitMethod integer Optional |
Cash limit method can be set to Amount or Percent of total credit line. Valid Values: 0 = Amount 1 = Percent of Total Credit Line Example : 0 |
|
CashLimitPercentage decimal Conditional |
Percent of total credit limit set for Percent cash limit method. Valid Values: 0-9 Format: XX.XX Example: 1.50 Condition: This field is mandatory when Cash limit method is Percent |
|
CashLimitAmount decimal Conditional |
Amount set for Amount cash limit method. Valid Values: 0-9 Format: XX.XX Example: 150.50 Condition: This field is mandatory when Cash limit method is Amount |
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,
"AccountID": 167257354,
"RatificationMethod1": null,
"PaymentType": null,
"FixedPaymentAmount": null,
"FixedPaymentPercentage": null,
"PaymentLevel": 0,
"PaymentHoldSkipCheck": null,
"EligibleForAutoSkipPaymentOpt": 0,
"CashLimitMethod": null,
"CashLimitPercentage": null,
"CashLimitAmount": null
}
Response fields detail
| Fields | Description |
|---|
Sample response body
{
"application/json": {
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": null
}
}
Get Account Control Parameters
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetActControlParams
Use this API to fetch account control parameters with their attributes, such as grace period provided, payment parameters, payment type, payment level, and cash advance parameters.
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 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. |
|
AccountNumber string Conditional |
Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AccountID/AdminNumber 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,
"AccountID": 167499,
"AccountNumber": "8000000000000078",
"AdminNumber": 129368
}
Response fields detail
| Fields | Description |
|---|---|
|
RatificationMethod1 integer |
Identifies the ratification method. Valid Values: 0 = Normal 1 = Grandfathered 2 = Statement |
|
PaymentType string |
Type of the Payment. Valid Values: 0 = Bill Balance 1 = Bill Fixed Amount 2 = Bill Fixed Percent 3 = Bill Invoice 4 = Bill Fixed Percent Of High Balance Example:0 = Bill Balance Allowable Values: 50 |
|
FixedPaymentAmount decimal |
Fixed amount define for Bill Fixed amount payment type. Valid Values:0-9 Format:XXXX.XX Example:1000.00 Condition: This field is mandatory when Payment type is Bill Fixed amount. |
|
FixedPaymentPercentage decimal |
Percent of principal define for Bill Fix Percent payment type. Valid Values:0-9 Format:XX.XX Example:1.00 Condition: This field is mandatory when Payment type is Bill Fix Percent. |
|
PaymentLevel string |
Define the level of Payment terms calculation. Valid Values: 0 = Account 1 = Plan 2 = Combined Example:0 = Account Allowable Values: 25 |
|
GracePeriod integer |
Define the Grace Period Valid Values: 0-9 Format:XX Example:25 |
|
PaymentHoldSkipCheck integer |
|
|
EligibleForAutoSkipPaymentOpt string |
Define if Account is Eligible for Automatic skip of payment, Valid Values: 0 = Eligible 1 = Not Eligible Allowable Values: 25 |
|
CashLimitMethod string |
Cash limit method can be set to Amount or Percent of total credit line. Valid Values: 0 = Amount 1 = Percent of Total Credit Line Allowable Values: 25 |
|
CashLimitPercentage decimal |
Percent of total credit limit set for Percent cash limit method. Valid Values: 0-9 Format: XX.XX Example:1.00 Condition: This field is mandatory when Cash limit method is Percent |
|
CashLimitAmount decimal |
Amount set for Amount cash limit method. Valid Values: 0-9 Format: XXXX.XXX Example:1000.00 Condition: This field is mandatory when Cash limit method is Amount. |
|
BillingTable integer |
Name of Billing table assigned to account. Valid Values: Format:ABC_FICO_XXX_XXX Example: ABC_FICO_740_749 |
Sample response body
{
"application/json": {
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"RatificationMethod1": 2,
"PaymentType": "2",
"FixedPaymentAmount": 0.0,
"FixedPaymentPercentage": 10.0,
"PaymentLevel": "1",
"GracePeriod": 21,
"PaymentHoldSkipCheck": 0,
"CashLimitMethod": "0.0000",
"CashLimitPercentage": 0.0,
"CashLimitAmount": 5000.0,
"BillingTable": 6765
}
}
}
Update Account Parameters
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdateAccountParameters
Use this API to update parameter attributes on a card account. The API allows a user to provide the field or parameter name in tags Field1–Field20" and their respective values in tags UpdateAccValue1–UpdateAccValue20 that needs to be updated on a card account. A user can update up to 20 parameters in a single request.
Note
In case you want to update multiple parameters, attributes which are more than 20 in number, then send a post request multiple time.
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 |
This tag reflects the Account number of Card holder. Valid Values: 0-9 Example: 8000000000000037 Condition: At least one of Card Number\Account Number is required. Allowable Values: 19 |
|
CardNumber string Conditional |
This tag reflect the card number. Valid Values:0-9 Example:1236547896541236 Condition:.At least one of Card Number\Account Number is required. Allowable Values: 19 |
|
CompanyNumber string Conditional |
Company Number Valid Values: 0-9 Example: 1234 Allowable Values: 7 |
|
AccountID integer Optional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example: 12345 |
|
AddressType string Conditional |
This tag reflects the type of address Valid Values: A-Z, 0-9 Example: Primary,Co-Owner,Correspondence Allowable Values: 5 |
|
Field1 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue1 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field2 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue2 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field3 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue3 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field4 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue4 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field5 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue5 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field6 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue6 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field7 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue7 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field8 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue8 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field9 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue9 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field10 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue10 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field11 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue11 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field12 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue12 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field13 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue13 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field14 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue14 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field15 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue15 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field16 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue16 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field17 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue17 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field18 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue18 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field19 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue19 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field20 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue20 string Conditional |
Values of the fields which need to be updated. Eg - If accountcatergory needs to be updates Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Reissue string Optional |
Activates Reissue functionality E.g.value: 1 or 2 Valid Values: 1,2 Example: 1/2 Allowable Values: 2 |
|
FileName string Optional |
File Name of PDF statement generated Valid Values: 0-9 A-Z Example: Statement_569845_02102020.PDF Allowable Values: 500 |
|
ApplicantType string Optional |
Description: Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= 'Applicant', 2 ='Co-Applicant', 3= 'Cosigner', Allowable Values: 20 |
|
StatusDescription string Optional |
A description for the selected Extended/Manual status Allowable Values: 20 |
|
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 |
This tag reflects the Account number of Card holder. Valid Values: 0-9 Example: 8000000000000037 Condition: At least one of Card Number\Account Number is required. Allowable Values: 19 |
|
CardNumber string Conditional |
This tag reflect the card number. Valid Values:0-9 Example:1236547896541236 Condition:.At least one of Card Number\Account Number is required. Allowable Values: 19 |
|
CompanyNumber string Conditional |
Company Number Valid Values: 0-9 Example: 1234 Condition: If any company details need to be updated. Allowable Values: 7 |
|
AccountID integer Optional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example: 12345 |
|
AddressType string Conditional |
This tag reflects the type of address Valid Values: A-Z, 0-9 Example: Primary,Co-Owner,Correspondence Allowable Values: 5 |
|
Field1 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue1 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field2 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue2 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field3 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue3 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field4 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue4 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field5 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue5 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field6 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue6 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field7 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue7 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field8 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue8 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field9 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue9 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field10 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue10 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field11 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue11 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field12 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue12 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field13 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue13 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field14 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue14 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field15 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue15 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field16 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue16 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field17 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue17 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field18 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue18 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field19 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue19 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Field20 string Conditional |
Field name which needs an update. Field name i.e.AccountCategory Valid Values: A-Z,0-9 Example: SCRAEffectiveDate,RegOFlag Allowable Values: 40 |
|
UpdateAccValue20 string Conditional |
Values of the fields which need to be updated. Eg - If account category needs to be updated Value of field AccountCategory Valid Values: A-Z,0-9 Example: 02/02/2010, N, 3456 Allowable Values: 40 |
|
Reissue string Optional |
Activates Reissue functionality E.g.value: 1 or 2 Valid Values: 1,2 Example: 1/2 Allowable Values: 2 |
|
FileName string Optional |
File Name of PDF statement generated Valid Values: 0-9 A-Z Example: Statement_569845_02102020.PDF Allowable Values: 500 |
|
ApplicantType string Optional |
Description: Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= 'Applicant', 2 ='Co-Applicant', 3= 'Cosigner', Allowable Values: 20 |
|
StatusDescription string Optional |
A description for the selected Extended/Manual status Allowable Values: 20 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountNumber": null,
"CardNumber": null,
"CompanyNumber": null,
"AccountID": 32441,
"AddressType": null,
"Field1": "EMPOCCUPATION",
"UpdateAccValue1": "77",
"Field2": "EMPINCOME",
"UpdateAccValue2": "10000000.00",
"Field3": "EMPYEARSOFEMPLOYMENT",
"UpdateAccValue3": "0.8",
"Field4": "EMPPOSITION",
"UpdateAccValue4": "Developer",
"Field5": "EMPORGANIZATIONNAME",
"UpdateAccValue5": "ISC",
"Field6": "EMPLOYEENUMBER",
"UpdateAccValue6": "43265",
"Field7": "EMPLOYERNAME",
"UpdateAccValue7": "ISC",
"Field8": "EMPADDRESS1",
"UpdateAccValue8": "test",
"Field9": "EMPADDRESS2",
"UpdateAccValue9": "test",
"Field10": "EMPCITY",
"UpdateAccValue10": "bhopal",
"Field11": "EMPSTATE",
"UpdateAccValue11": "MP",
"Field12": "EMPPOSTALCODE",
"UpdateAccValue12": "46200",
"Field13": "EMPCOUNTRY",
"UpdateAccValue13": "IND",
"Field14": "EMPPHONENUMBER",
"UpdateAccValue14": "9765645454565",
"Field15": "EMPFAXNUMBER",
"UpdateAccValue15": "8546443563",
"Field16": null,
"UpdateAccValue16": null,
"Field17": null,
"UpdateAccValue17": null,
"Field18": null,
"UpdateAccValue18": null,
"Field19": null,
"UpdateAccValue19": null,
"Field20": null,
"UpdateAccValue20": null,
"Reissue": null,
"FileName": null,
"ApplicantType": null,
"StatusDescription": null
}
Response fields detail
| Fields | Description |
|---|---|
|
AccountNumber string |
This tag reflects the Account number of Card holder. Valid Values: 0-9 Example: 8000000000000037 Allowable Values: 19 |
|
CardNumber string |
This tag reflects the card number. Valid Values:0-9 Example:1236547896541236 Allowable Values: 19 |
|
CompanyName string |
Company Name Valid Values: A-Z,0-9 Example: ABC Allowable Values: 40 |
|
CompanyNumber string |
Company Number Valid Values: 0-9 Example: 1234 Allowable Values: 7 |
|
CorporateAccountNumber string |
Account Number of the corporate entity. Valid Values:0-9, A-Z Format:XXXX Example:1234 Allowable Values: 19 |
|
ReasonCode string |
Reason code field for Error or Success of API Valid Values: 1/0 Example: 1,0 Allowable Values: 30 |
|
Memo string |
Note for each erroneous input.Two letter code Valid Values: A-Z,0-9 Example: 12 Allowable Values: 100 |
|
OtherError string |
Return Error Message in case of Other Error.Example: Unknown error occurred Valid Values: A-Z, 0-9 Example: Unknown error occurred,Network Error etc. Allowable Values: 100 |
|
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server Valid Values: 0-9,a-z Example: 200 Allowable Values: 15 |
|
DerivedPartnerStatus string |
Derived status based on Account Status, Card Manual Status and Embossing Status. Possible values - Active Blocked Cancelled Disabled N/A New Valid Values:0-9, A-Z Format:XXXX Example:Active Blocked Cancelled Disabled N/A New Allowable Values: 50 |
|
AccountNumber string |
This tag reflects the Account number of Card holder. Valid Values: 0-9 Example: 8000000000000037 Allowable Values: 19 |
|
CardNumber string |
This tag reflects the card number. Valid Values:0-9 Example:1236547896541236 Allowable Values: 19 |
|
CompanyName string |
Company Name Valid Values: A-Z,0-9 Example: ABC Allowable Values: 40 |
|
CompanyNumber string |
Company Number Valid Values: 0-9 Example: 1234 Allowable Values: 7 |
|
CorporateAccountNumber string |
Account Number of the corporate entity. Valid Values:0-9, A-Z Format:XXXX Example:1234 Allowable Values: 19 |
|
ReasonCode string |
Reason code field for Error or Success of API Valid Values: 1/0 Example: 1,0 Allowable Values: 30 |
|
Memo string |
Note for each erroneous input.Two letter code Valid Values: A-Z,0-9 Example: 12 Allowable Values: 100 |
|
OtherError string |
Return Error Message in case of Other Error.Example: “Unknown error occurred†Valid Values: A-Z, 0-9 Example: Unknown error occurred,Network Error etc. Allowable Values: 100 |
|
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server Valid Values: 0-9,a-z Example: 200 Allowable Values: 15 |
|
DerivedPartnerStatus string |
Derived status based on Account Status, Card Manual Status and Embossing Status. Possible values - Active Blocked Cancelled Disabled N/A New Valid Values:0-9, A-Z Format:XXXX Example:Active Blocked Cancelled Disabled N/A New Allowable Values: 50 |
Sample response body
{
"application/json": {
"Message": "Account updated successfully",
"Status": true,
"ErrorCode": "ERR01003",
"ResponseData": {
"AccountNumber": "0000007063766272",
"CardNumber": "125412******9532",
"CompanyName": null,
"CompanyNumber": null,
"CorporateAccountNumber": null,
"ReasonCode": "1",
"Memo": "Account Updated Successfully.",
"OtherError": null,
"ResponseID": "108422264",
"DerivedPartnerStatus": null
}
}
}
Change Plan
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/ChangePlan
Use this API to indicate the existing credit plan master type as deferred plan or equal payment plan or revolving plan.
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:XXXXX Example:12345 Condition: At least one of AdminNumber/AccountNumber/AccountID is required |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one of AdminNumber/AccountNumber/AccountID is required Allowable Values: 19 |
|
AccountID integer Conditional |
//TD#240549 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 of AdminNumber/AccountNumber/AccountID is required |
|
TransactionID string Mandatory |
Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789 Allowable Values: 20 |
|
CreditPlanMaster string Mandatory |
New Plan name which need to be updated. Values for credit plan master would be pulled by "GetPromotionBYAmount" API. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full Allowable Values: 19 |
|
MemoReasonID string Optional |
Reason of Memo Text Valid Values:0-9, a-z,special characters Format:XXXXXXXXX Example: New transaction. Allowable Values: 50 |
|
MemoText string Optional |
Text of the Memo. Valid Values:0-9, a-z,special characters Format:XXXXXXXXX Example: New Transaction posted. 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,
"AdminNumber": null,
"AccountNumber": "8000000000000235",
"AccountID": null,
"TransactionID": "123372036854814158",
"CreditPlanMaster": "5889",
"MemoReasonID": null,
"MemoText": null
}
Response fields detail
| Fields | Description |
|---|---|
|
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{
"application/json": {
"Message": "Plan has been changed successfully.",
"Status": true,
"ErrorCode": "ERR01037",
"ResponseData": null
}
}
Extend Term Completion
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/ExtendTermCompletion
Use this API to extend the tenure of the plan which is in promo currently using account number or account ID or admin number along with other mandatory fields. This API fetches out the result in the form of success or failure.
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 the account whose interest deferment is to be extended. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Admin Number of the account whose interest deferment is to be extended. Valid Values:0-9 Format:XXXXX Example:12345 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID |
|
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 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID |
|
PlanID integer Mandatory |
ID of the plan who's term is to be extended. Valid Values: 0 - 9 Format: xxxx Example: 72456 |
|
ExtendedTerms integer Mandatory |
Terms to be extended (In cycle). Valid Values: 0-12 Format: xx Example: 12 Allowable Values: 20 |
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": "8000000000000235",
"AdminNumber": null,
"AccountID": null,
"PlanID": 101364,
"ExtendedTerms": 3
}
Response fields detail
| Fields | Description |
|---|---|
|
OLDTermCompletionDate datetime |
Term Completion Date before extension Valid Values:0-9 Format:MM/dd/yyyy HH:mm:ss Example:01/02/2020 12:00:00 |
|
TermCompletionDate datetime |
Term Completion Date after extension. Valid Values:0-9 Format:MM/dd/yyyy HH:mm:ss Example:02/02/2020 12:00:00 |
Sample response body
{
"application/json": {
"Message": "Success",
"Status": true,
"ErrorCode": "ERR01037",
"ResponseData": {
"OLDTermCompletionDate": "10/02/2016 00:00:00",
"TermCompletionDate": "11/02/2016 00:00:00"
}
}
}
Update Network Information
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/UpdateNetworkInformation
A card issuer or processor can utilize the CoreCARD's platform to issue cards and process various transaction types (e.g., purchase, payment, adjustment, transfer) received within the closed-loop environment. This API can be used to update network information within a closed-loop environment's network. The user must input a valid network ID to move an account to a particular network or a value of "1" to move it from a particular network to an open network.
Note
Network in this context pertains to a group of merchants formed within a closed-loop environment. Open network in this context pertains to all merchant under all groups present within a closed-loop environment for a specific institution.
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 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 of AccountNumber or AccountID is required. |
|
NetworkID int64 Mandatory |
System generated ID Assigned on the Network Valid Values: -1 or any network ID that to be updated for Account If User Inputted '-1' as value in NetworkID Tag, then the Account will Become a No Network Account and Will not be Part of an exclusive Network If User Inputed a valid 'Network ID' NetworkID Tag, the Account will Become a Part of an exclusive Network of the Network ID inputted Example: 12345 |
|
AccountNumber string Conditional |
Account number of cardholder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber or AccountID is required. Allowable Values: 19 |
Sample request body
{
"Source": "WEB",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountNumber": null,
"AccountID": 6106,
"NetworkID": 1003
}
Response fields detail
| Fields | Description |
|---|
Sample response body
{
"application/json": {
"Message": "Account updated successfully",
"Status": true,
"ErrorCode": "ERR01003",
"ResponseData": null
}
}
