Control Parameters
Control parameters in the CoreCard system are configurable options available to govern the card's account functioning and behavior. These control parameters are pre-requisites to performing any monetary or non-monetary card operation. The configurable options include a new Institution setup, fee setup, interest parameters setup, transaction codes setup, authorization rules setup, and card or account status setup. You can retrieve the existing setup in the CoreCard system to review and apply certain validations. Moreover, you can utilize the APIs to set up robust loyalty rules.
Get Credit Plan Master By Institution ID
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetCreditPlanMasterByInstitutionID
Use this API to get the credit plan master (CPM) information by providing the institution ID. The API returns CPMs with details such as plan type, plan description, payment type, equal payments, and deferment options.
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 Optional |
Unique identification number for Institution Valid Values: 0-9 Example: 12345 |
ProductID integer Optional |
ProductID Valid Values: 0-9 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, "InstitutionID": 3189 }
Response fields detail
Fields | Description |
---|---|
ListPlanType array |
ListPlanType |
Sample response body
{ "application/json": { "Message": "Account Details Return Successfully", "Status": true, "ErrorCode": "ERR01084", "ResponseData": { "ListPlanType": [ { "CPMAccountID": 5915, "CreditPlanType": "0", "CPMDescription": "SelfScore Achieve Def180", "PaymentType": 2, "EqualPayments": null, "InterestDefermentPeriod": 1, "PaymentDefermentPeriod": null, "CreditPlanNumber": "5915", "MerchantPlan": "No" }, { "CPMAccountID": 5917, "CreditPlanType": "0", "CPMDescription": "SelfScore Classic Revolving", "PaymentType": 2, "EqualPayments": null, "InterestDefermentPeriod": null, "PaymentDefermentPeriod": null, "CreditPlanNumber": "5917", "MerchantPlan": "No" } ] } } }
Update MSR Control Parameter
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/UpdateMSRControlParameter
Use this API to update the control parameters of any merchant, store, or register entity, such as DateFormat, CurrencyCode, CurrencySymbolType, Language, and statement message group for any merchant, store, or register.
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 |
MerchantID integer Mandatory |
Unique number of merchant account. Valid Values:0-9 Example:12345 |
StatementMessageGroup string Mandatory |
The Merchant Statement Message Group. Valid Values: A-Z, 0-9, Example:abc Allowable Values: 50 |
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, "MerchantID": 4785, "StatementMessageGroup": "1458" }
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. Allowable Values: 15 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ResponseID": "108410544" } } }
Get All Lookup
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetAllLookup
Use this API to get all the combo values belonging to a field. If one field has multiple combo values like the country field has multiple values then this API will return all country names and their codes. This code should be used in other APIs in-country field.
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 |
LutID string Mandatory |
LutID Allowable Values: 1000 |
LutDescription string Optional |
LutDescription Allowable Values: 100 |
LutCode string Optional |
LutCode Allowable Values: 50 |
LutRelation string Optional |
LutRelation Allowable Values: 30 |
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, "LutID": "Country", "LutDescription": null, "LutCode": null, "LutRelation": null }
Response fields detail
Fields | Description |
---|---|
ListAllLookup array |
ListAllLookup |
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ListAllLookup": [ { "LutID": "Country", "LutCode": "US", "LutDescription": "United States", "LutLanguage": "dbb", "DisplayOrder": 0, "LutRelation": null, "Module": "BC" } ], "CurrencySymbol": null } } }
Get Account Control
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetAccountControl
Use this API to obtain the parameters configured for a merchant account's control table.
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 |
AccountControlTableNameID integer Mandatory |
Unique ID for a Name of Account Controls like Interest, Payment , Processing Parameters defined etc when defining any Product. Valid Values:0-9 Format:XX Example:1 |
MerchantID integer Mandatory |
Unique number of merchant account Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549 |
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 |
AccountControlTableNameID integer Mandatory |
Unique ID for a Name of Account Controls like Interest, Payment , Processing Parameters defined etc when defining any Product. Valid Values:0-9 Format:XX Example:1 |
MerchantID integer Mandatory |
Unique number of merchant account Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549 |
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, "AccountControlTableNameID": 6859, "MerchantID": 11607 }
Response fields detail
Fields | Description |
---|---|
AccountControlDetails
|
List of all the Account controls details defined on Product. |
AccountControlDetails
|
List of all the Account controls details defined on Product. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "AccountControlDetails": { "MerchantID": 11607, "AccountControlTableName": 6859, "PrimaryCurrencyCode": "US Dollar", "AccountControlTableParent": 1, "MonetaryTransactionControlGroup": 78, "PurchasePlanMaster": 6153, "CashPlanMaster": null, "CashLimitMethod": 0, "CashLimitAmount": 10000.0, "CashLimitPercentage": 0.0, "GeneralFeeDisclosureMethod": 1, "GeneralFeeDisclosureCycles": 2, "AccountBillingTypeMethod": 1, "MerchantCategoryCodeGroupName": 1024, "PaymentDueMethod": 2, "PaymentDueDaysAfterCycle": null, "MinimumPaymentType": null, "MinimumPaymentPercent": null, "MinimumPaymentAmount": null, "PromoOnlyMinimumPaymentAmount": 0.0, "PaymentConsolidationPlanMaster": null, "PaymentLevel": 1, "MinimumDuePaymentLevel": 1, "PaymentType": null, "FixedPaymentAmount": null, "FixedPaymentPercentage": null, "BillEvenDollars": 0, "BillOverLimit": 1, "BillThresholdAmount": 1.0, "ACHPaymentGenerationAdjustment": 0, "Balance": 0, "Principal": 2, "TransactionFees": 2, "AnnualFees": 2, "LateFees": 1, "Interest": 2, "InsufficientFundsFees": 1, "CollectionFees": 2, "Insurance": 2, "OverLimitFees": 2, "RecoveryFees": 2, "MinimumPaymentPriorityFlag": 0, "MaximumDaystoFirstPaymentDueDate": 53, "MinimumDaystoFirstPaymentDueDate": 30, "BillingCycleFrequency": 0, "CalculateAmountDueDate": 1, "Monthly1": 24, "Monthly2": 25, "Monthly3": 26, "Monthly4": 27, "Monthly5": 28, "Monthly6": 1, "Monthly7": 2, "Monthly8": 3, "Monthly9": 4, "Monthly10": 5, "Monthly11": 6, "Monthly12": 7, "Monthly13": 8, "Monthly14": 9, "Monthly15": 10, "Monthly16": 11, "Monthly17": 12, "Monthly18": 13, "Monthly19": 14, "Monthly20": 15, "Monthly21": 16, "Monthly22": 17, "Monthly23": 18, "Monthly24": 19, "Monthly25": 20, "Monthly26": 21, "Monthly27": 22, "Monthly28": 23, "Monthly29": null, "Monthly30": null, "Monthly31": null, "MinimumInterestCalculationMethod": 1, "ConsiderationofDeferredInterest": 0, "MinimumInterestAmount": 2.0, "AccrueInterestonChargedOffAccounts": 0, "InterestDisclosureMethod": 1, "InterestDisclosureCycles": 2, "SegmentsSubjectToGraceDays": 3, "GraceDaysMethod": 2, "NumberofGraceDays": 5, "PreviousCycleGrace": 0, "UsePartialGraceDays": 0, "InterestOnGraceReactivation": 1, "BalanceSubjectToGraceOn": 1, "ContractualDelinquencyMethod": 0, "ContractualDelinquencyLevel": 2, "ContractualDelinquencyCureStatus": 2, "LateDelinquencyMethod": 1, "LateDelinquencyLevel": 1, "LateDelinquencyCureStatus": 2, "Delinquency2CureAction": 1, "Delinquency2Timing": null, "DefaultBalanceTransferPlan": null, "OverlimitBalance": 2, "ContractualDelinquency2Level": null, "ContractualDelinquency2Status": null, "ContractualDelinquency2CureStatus": null, "LateDelinquency2Level": 61, "LateDelinquency2Status": 9972, "LateDelinquency2CureStatus": 3 } } } }
Get Monetary Transaction Control
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetMonetaryTransactionControl
Use this API is to obtain details of the logic modules and transaction codes, such as transaction type, short transactions description, and transaction type.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
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 |
LogicModule string Mandatory |
Logic module Valid Values:o-9 Format:XX Example:40 Allowable Values: 5 |
TransactionCode string Optional |
Payment Transaction Code Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT 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 |
LogicModule string Mandatory |
Logic module Valid Values:o-9 Format:XX Example:40 Allowable Values: 5 |
TransactionCode string Optional |
Description: The unique, user-defined number assigned to the transaction Valid Values: 0-9,A-z Example: 1360 = Bad Debit settlement 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, "LogicModule": "02", "TransactionCode": null }
Response fields detail
Fields | Description |
---|---|
TranCodesList array |
get or set TranCodes |
TranCodesList array |
get or set TranCodes |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "TranCodesList": [ { "LogicModule": "02 = Billed Interest", "TransactionCode": "36112 = INTEREST CHARGES", "TransactionType": "Debit", "TransactionDescription": "INTEREST CHARGES", "ShortDescription": null, "SendToLedger": "No", "Commission": "No", "AccountReceivableDebitLedger": null, "AccountReceivableCreditLedger": null, "ProfitLossDebitLedger": null, "ProfitLossCreditLedger": null, "BackdatedMethod": null, "BackdatedDays": null, "FuturedatedMethod": null, "FuturedatedDays": null, "MTCStatus": "Active", "TransactionCodeType": "INT", "IncludeInStatementTotals": "Both YTD and CTD Totals" } ] } } }
Manage Inventory Class
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/ManageInventoryClass
Use this API to update, delete, or create a new inventory class.
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 |
InventoryCode string Mandatory |
These are the codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:35519 Allowable Values: 5 |
InventoryClass string Mandatory |
These are the classes defined for any products/inventory to make post sales transaction. Valid Values:0-9 Example:1234 Allowable Values: 10 |
InternalInventoryClass string Optional |
These are the internal ID for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:6049 - Accessories Allowable Values: 10 |
InventoryClassDescription string Conditional |
These are the description given for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:Bags,Belts Allowable Values: 95 |
DecisionFlag integer Mandatory |
Decision Flag to decide what action has to perform on the API Valid Values: 1-Create, 2-Update, 3-Delete Format:X Example:1,2,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 |
InventoryCode string Mandatory |
These are unique ID for Inventory codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:35519 Allowable Values: 5 |
InventoryClass string Mandatory |
These are the classes defined for any products/inventory to make post sales transaction. Valid Values:0-9 Example:1234 Allowable Values: 10 |
InternalInventoryClass string Optional |
These are the internal ID for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:6049 - Accessories Allowable Values: 10 |
InventoryClassDescription string Conditional |
These are the description given for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:Bags,Belts Allowable Values: 95 |
DecisionFlag integer Mandatory |
Decision Flag to decide what action has to perform on the API Valid Values: 1-Create, 2-Update, 3-Delete Format:X Example:1,2,3 |
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, "InventoryCode": "21451", "InventoryClass": "3625", "InternalInventoryClass": "6049", "InventoryClassDescription": "Description of Inventory Class", "DecisionFlag": 1 }
Response fields detail
Fields | Description |
---|---|
InventoryClass array |
Inventory Class List |
InventoryClassList array |
Inventory Class List |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InventoryClassList": [ { "InventoryCode": "21451", "InventoryClass": "3625", "InternalInventoryClass": "6049", "InventoryClassDescription": "Description of Inventory Class" } ] } } }
Manage Inventory Code
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/ManageInventoryCode
Use this API to add a new inventory code.
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 |
InventoryCode string Mandatory |
These are the codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:35519 Allowable Values: 5 |
InventoryCodeDescription string Conditional |
These are the description of codes defined for any products/inventory to make post sales transaction. Valid Values:A-Z,0-9 Condition: If Decision flag is 1 or 2 , this needs to be filled. Allowable Values: 100 |
DecisionFlag integer Mandatory |
Decision Flag to decide what action has to perform on the API Valid Values: 1-Create, 2-Update, 3-Delete Format:X Example:1,2,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 |
InventoryCode string Mandatory |
These are unique ID for Inventory codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:35519 Allowable Values: 5 |
InventoryCodeDescription string Conditional |
These are the description of codes defined for any products/inventory to make post sales transaction. Valid Values:A-Z,0-9 Example:Andersein Morton Condition: If Decision flag is 1 or 2 , this needs to be filled. Allowable Values: 100 |
DecisionFlag integer Mandatory |
Decision Flag to decide what action has to perform on the API Valid Values: 1-Create, 2-Update, 3-Delete Format:X Example:1,2,3 |
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, "InventoryCode": "21451", "InventoryCodeDescription": "Description of Inventory Code", "DecisionFlag": 1 }
Response fields detail
Fields | Description |
---|---|
InventoryCodes array |
Inventory Code List |
InventoryCodes array |
Inventory Code List |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InventoryCodes": [ { "InventoryCode": "21451", "InventoryCodeDescription": "Description of Inventory Code" } ] } } }
Manage Statement Messages
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/ManageStatementMessages
Use this API to manage the statement messages in terms of adding/updating/deleting the message text to be displayed in the message text in the statement in the last section. API should be provided with input accordingly to add, update or delete the statement message texts.
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 |
To decide if the API is getting used for Add/Update/Delete. Valid Values: 0 = Add 1= Update 2=Delete Example: 0 |
StatementMessage
|
StatementMessage |
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": 0, "StatementMessage": { "InstitutionID": 1320, "StatementMessageGroupCode": "27", "StatementMessageTypeCode": "51", "StatementTypeCode": "0", "StatementMessageCode": "333", "StatementMessage": "Your promotional offer on purchases will end on <Promo End Date>", "Priority": 1, "CurrentBalance": null, "MessagePeriod": null, "LastDigitOfAccountNumber": null, "Language": "en" } }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": null } }
Get Product Reward Transaction Mapping
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetProductRewardTxnMapping
Use this API to obtain the loyalty programs mapped to the card program and transaction types used to calculate reward points.
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 |
ProductID integer Mandatory |
ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
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 Mandatory |
ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
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, "ProductID": 1419 }
Response fields detail
Fields | Description |
---|---|
LoyaltyRuleBasedTxnCodeList array |
Array to list all the transactions which are mapped for earning rewards. |
LoyaltyRuleBasedTxnCodeList array |
Array to list all the transactions which are mapped for earning rewards. |
Sample response body
{ "application/json": { "Message": "Record Found", "Status": true, "ErrorCode": "ERR01520", "ResponseData": { "LoyaltyRuleBasedTxnCodeList": [ { "LoyaltyProgramName": "Final Loyalty Program", "MonetaryTransactionCode": "8801 = FINANCE CHARGE CREDIT OUT", "DebitCreditIndicator": "Credit", "LoyaltyTransactionCodeGroup": "Loyalty Group", "LoyaltyDebitTransactionCode": "603 = LOYALTY CREDIT ADJUSTMENT", "LoyaltyCreditTransactionCode": "7603 = MANUAL LOYALTY CREDIT ADJUSTMENT" }, { "LoyaltyProgramName": "TheLockerRoom", "MonetaryTransactionCode": "8810 = OVERLIMIT FEE DEBIT IN", "DebitCreditIndicator": "Credit", "LoyaltyTransactionCodeGroup": "SelfScore Loyalty MTCG", "LoyaltyDebitTransactionCode": "Loyalty Debit", "LoyaltyCreditTransactionCode": "Loyalty Credit" } ] } } }
Manage Statement Message Group
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/ManageStatementMessageGroup
Use this API to manage the statement message group i.e. to Add/Delete/Update the group on the product.
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 |
To decide if API is getting used for Add or Update or Delete the Statement Message Group. Valid Values: 1- Create 2- Update 3-Delete Example:1 |
StatementMessageGroup string Conditional |
Name of Statement Message Group Valid Values: A-Z, 0-9, Example: StmtMsgGroup1 Condition: This shall be a mandatory field with DecisionFlag = 1. This will be optional in case Decision flag = 2 or 3. Allowable Values: 100 |
StatementMessageGroupCode string Optional |
Code of the statement message group which is created to group all the statement messages. Valid Values: Code which is generated with this API at the time of Create or get this via GetStatementMessageGroup API. Example: 100 Condition: This will work with DecisionFlag = 2 or 3. Allowable Values: 5 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "DecisionFlag": 1, "StatementMessageGroup": "Second Group", "StatementMessageGroupCode": "30" }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": null } }
Get Inventory Codes
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetInventoryCodes
Use this API to obtain the defined inventory codes used for a sales transaction. The API returns a list of all Inventory codes linked to a card program or inventory to make a post-sales transaction.
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 |
InventoryCode string Mandatory |
These are the codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Format:XXXX Example:35519 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, "InventoryCode": "11158" }
Response fields detail
Fields | Description |
---|---|
InventoryCodeList array |
This is the list of inventory codes defined on the system. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InventoryCodeList": [ { "InventoryCodeID": "11158", "InventoryCodeDescription": "John Norman" } ] } } }
Get Inventory Class
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetInventoryClass
Use this API to obtain the defined inventory class for inventory codes used for a sales transaction to make a post-sales transaction by using the inventory code and internal inventory class.
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 |
InventoryCode string Mandatory |
These are unique ID for Inventory codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Format: Example:35519 Allowable Values: 255 |
InventoryClass string Optional |
These are the classes defined for any products/inventory to make post sales transaction. Valid Values:0-9 Format: Example:1234 Allowable Values: 255 |
InternalInventoryClass string Mandatory |
These are the internal ID for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:6049 - Accessories Allowable Values: 255 |
InventoryClassDescription string Optional |
These are the description given for classes made based on Inventory Codes defined for any products/inventory to make post sales transaction. Valid Values:0-9, A-Z Example:Bags,Belts Allowable Values: 255 |
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, "InventoryCode": "35519", "InventoryClass": null, "InternalInventoryClass": "1030", "InventoryClassDescription": null }
Response fields detail
Fields | Description |
---|---|
InventoryClassList array |
Inventory Class List |
TotalCount integer |
This tag will show the total count of the Inventory Class wiith the respective search made. Valid Values:0-9 Example:12 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InventoryClassList": [ { "InventoryCode": "35519", "InventoryClass": "Andrisen", "InternalInventoryClass": "1030 = inventoryclass1", "InventoryClassDescription": "inventoryclass1" } ], "TotalCount": 1 } } }
Get Interest Charge
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetInterestCharge
Use this API to obtain the interest charges defined for a merchant for different interest plans by using the interest plan ID and merchant ID. The API returns other available details such as interest set on a fixed rate and the index rate for a variable rate.
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 |
MerchantID integer Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489 |
InterestPlanID integer Mandatory |
Interest Plan Id defined on Intreset Tables . Valid Values:0-9, A-z Format:XX Example:Greensky_IP_22.99 |
InterestPlanParent integer Optional |
Parent Name of Interest Plan Valid Values:0-9, A-z Format:XX Example:1234 |
InterestTransactionCode string Optional |
Transaction Code for Interest Valid Values:0-9, A-z Format:XX Example:2000-Intreset Charge Allowable Values: 20 |
MonetaryTransactionControlGroup integer Optional |
Group defined on a product for its monetary transaction like defining Fees, Interest, Transactioncodes etc. Valid Values:0-9 Format:XX Example:Greensky_MTCG |
PrimaryCurrencyCode string Optional |
Code for PrimaryCurrency. Valid Values: XXX Format: 0-9 Example: 1234 Allowable Values: 3 |
ProductType string Optional |
It provides a description of the type of card being processed Valid Values:0-9, a-z Format:XXXXX Example:BankCard Allowable Values: 5 |
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, "MerchantID": 7031, "InterestPlanID": 1231, "InterestPlanParent": null, "InterestTransactionCode": null, "MonetaryTransactionControlGroup": null, "PrimaryCurrencyCode": null, "ProductType": null }
Response fields detail
Fields | Description |
---|---|
InterestChargeDetails
|
list of Interest Charges defined on a Merchant. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InterestChargeDetails": { "PrimaryCurrencyCode": "US Dollar", "InterestPlanParent": "Template Record", "MonetaryTransactionControlGroup": "Final MTC", "InterestTransactionCode": "6614 = INTEREST CHARGES", "MerchantName": "7031", "ProductType": "Bankcard", "InterestonAnnualFees": 1, "InterestonInsufficientFundsFees": 1, "InterestonInterest": 1, "InterestonTransactionFees": 1, "InterestonOverlimitFees": 1, "InterestonInsurance": 1, "InterestonCollectionFees": 1, "InterestonRecoveryFees": 1, "InterestonLateFees": 1, "InterestStartDebit": 1, "InterestStartCredit": 0, "InterestNextStatement": 2, "InterestNextStatementMethod": 5, "YearBase": 0, "AccuralMethod": 2, "InterestCalculationRounding": 0, "DeliquencyLevel": 0, "InterestRateType": 1, "MinimumInterestRate": 0.0, "MaximumInterestRate": 0.0, "MaximumRateDecrease": 0.0, "MaximumRateIncrease": 0.0, "FixedRate1": 17.9, "FixedRate2": 0.0, "FixedRate3": 0.0, "FixedRate4": 0.0, "TierLimitIndicatorFixedRate": 0, "Tiermaximumbalance1FixedRate": 0.0, "Tiermaximumbalance2FixedRate": 0.0, "Tiermaximumbalance3FixedRate": 0.0, "IndexRateParent": 2000, "MarginRateParent": 2000, "MarginRateParent2": null, "MarginRateParent3": null, "MarginRateParent4": null, "IndexRate": 3.5, "MarginRate": 14.5, "MarginRate2": 0.0, "MarginRate3": 0.0, "MarginRate4": 0.0, "TierLimitIndicatorVariableRate": 0, "Tiermaximumbalance1VariableRate": 0.0, "Tiermaximumbalance2VariableRate": 0.0, "Tiermaximumbalance3VariableRate": 0.0 } } } }
Get Billing Table By Product
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetBillingTableByProduct
Use this API to get the list of billing tables mapped on product or merchant.
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 |
ProductID integer Conditional |
ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
MerchantID integer Conditional |
Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
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 Conditional |
ID assigned to a Product Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
MerchantID integer Conditional |
Unique number of merchant account 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, "ProductID": null, "MerchantID": 11607 }
Response fields detail
Fields | Description |
---|---|
GetBillingTableList array |
List of of Billing table defined on the Merchant. Example:Greensky_FICO_620_629 |
GetBillingTableList array |
List of of Billing table defined on the Merchant. Example:Greensky_FICO_620_629 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "GetBillingTableList": [ { "BillingTableID": 2181, "BillingTableName": "GreenSky_FICO_580_619", "IsDefault": true, "PIIRequired": null }, { "BillingTableID": 2181, "BillingTableName": "GreenSky_FICO_620_629", "IsDefault": false, "PIIRequired": null } ] } } }
Get Billing Table Detail
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetBillingTableDetail
Use this API to obtain the billing table details defined for the merchant account, including interest plans, rectification plans, service charges, account control tables, and card products.
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 |
BillingTableId integer Mandatory |
Unique ID of Billing table assigned to defined for a Merchant Valid Values:0-9, a-z Format:XXXX Example:123 |
MerchantID integer Mandatory |
Unique number of merchant account 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, "BillingTableID": 2181, "MerchantID": 7031 }
Response fields detail
Fields | Description |
---|---|
BillingTableDetails
|
billingTableDetails |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "BillingTableDetails": { "ProductType": "Bankcard", "MonetaryTransactionControlGroup": "Final MTC", "BillingTableParent": "Template Record", "PrimaryCurrencyCode": "US Dollar", "AccountID": 2181, "MerchantName": "Final", "NegativeRewardBalanceToCharge": 1, "CardVendorID": null, "CardProduct": null, "ProductConfigurationID": 1231, "ServiceChargePlanName": 141, "AccountControlTableName": 2061, "InterestPlan1": 1231, "InterestPlan2": 1241, "InterestPlan3": null, "InterestPlan4": null, "InterestPlan5": null, "InterestPlan6": null, "InterestPlan7": null, "InterestPlan8": null, "InterestPlan9": null, "InterestPlan10": null, "InterestPlan11": null, "InterestPlan12": null, "InterestPlan13": null, "InterestPlan14": null, "InterestPlan15": null, "InterestPlan16": null, "InterestPlan17": null, "InterestPlan18": null, "InterestPlan19": null, "InterestPlan20": null, "InterestPlan21": null, "InterestPlan22": null, "InterestPlan23": null, "InterestPlan24": null, "RatificationMethod1": 0, "RatificationMethod2": 0, "RatificationMethod3": 0, "RatificationMethod4": 0, "RatificationMethod5": null, "RatificationMethod6": null, "RatificationMethod8": null, "RatificationMethod9": null, "RatificationMethod10": null, "RatificationMethod11": null, "RatificationMethod12": null, "RatificationMethod13": null, "RatificationMethod14": null, "RatificationMethod15": null, "RatificationMethod16": null, "RatificationMethod17": null, "RatificationMethod18": null, "RatificationMethod19": null, "RatificationMethod20": null, "RatificationMethod21": null, "RatificationMethod22": null, "RatificationMethod23": null, "RatificationMethod24": null, "InsurancePlan1": null, "InsurancePlan2": null, "InsurancePlan3": null, "InsurancePlan4": null, "InsurancePlan5": null, "InsurancePlan6": null } } } }
Get Institution Parameters
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetInstitutionParameters
Use this API to obtain parameters and attributes configured for an institution entity created in the system.
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 |
Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "InstitutionID": 1332 }
Response fields detail
Fields | Description |
---|---|
InstitutionAssociations array |
List of Institution Associations |
InstitutionReports array |
List of All InstitutionReports |
InstitutionData
|
IntitutionData |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "InstitutionAssociations": [ { "NetworkType": "MC", "ProcessorID": "220203" } ], "InstitutionReports": [ { "ReportName": "", "ScheduleType": "BUSINESSDATE", "ScheduleTime": null, "DeliveryMechanism": "Online", "DeliveryFrequency": "Daily", "FTPAddress": null, "FTPLogin": null, "FtpPassword": null, "EmailAddress": null }, { "ReportName": "", "ScheduleType": "BUSINESSDATE", "ScheduleTime": null, "DeliveryMechanism": "Hardcopy", "DeliveryFrequency": "Monthly 31", "FTPAddress": null, "FTPLogin": null, "FtpPassword": null, "EmailAddress": null } ], "InstitutionData": { "InstitutionName": "Final Inc.", "InstitutionParentName": "Template Record", "DestinationAlignment": 1, "DestinationRTAlignment": 1, "OriginationAlignment": 1, "TINAlignment": 1, "CompanyNameAlignment": 0, "CompanyIdAlignment": 1, "ECCAlignment": 0, "CEDAlignment": 0, "ACHCutoffTime": null, "NoOfTxnInACHFile": null, "BankVerificationMethod": "1", "CompanyID": "F460187030", "EntryClassCode": null, "CompanyEntryDescription": null, "INSTEmail": null, "BillingMethod": 0, "InstitutionAddressLine1": "655 Castro Street #7", "InstitutionAddressLine2": "", "INSTCity": "Mountain View", "Country": "US", "StateProvince": "CA", "postalcode": "94041", "TollFreeNumber": null, "SystemOperatorMail": null, "CustSvcPhoneNmbr": "1-855-552-5375", "CollectionPhoneNmbr": null, "FaxNumber": null, "CreditFileEmailAddr": null, "destination": "FEDERAL RESERVE BANK", "DestinationRoutingAndTransit": "691000134", "origination": "FIRST BANK & TRUST", "OriginationRoutingAndTransit": "91408446 ", "Prenote": 1, "delayDes": 0, "MultipleFileIdentifier": null, "TaxIdentificationNumber": "091408446 ", "ImmediateDestinationName": null, "SecondaryCurrencyDestination": null, "SecondaryCurrencyOrigination": null, "SecondaryDestinationRoutingAndTransit": null, "SecondaryOriginationRoutingAndTransit": null, "SecondaryCurrDestinationName": null, "SecondaryCurrOriginationName": null, "PaymentDescription": "Payment", "ACHProcessing": 0, "CollectionInterface": 0, "GenerateStatement": 0, "SeparateEmbossingFile": 0, "TemporaryCardCreation": 0, "LoyaltyActive": 0, "ArchivingFrequency": null, "HoldStatement": 0, "CardSequenceNumberPosition1Track1": 1, "CardSequenceNumberPosition2Track1": 6, "CVNStartingPositionTrack1": 11, "PINOffsetStartingPositionTrack1": 2, "CardSequenceNumberPosition1": 1, "CardSequenceNumberPosition2": 6, "CVNStartingPosition": 11, "PINOffsetStartingPosition": 2, "ProcessOfacChecks": 1, "OFACCheckMethod": 1, "LastBulkOFACCheckDate": null, "FileUploadFrequency": 12, "ThresholdIndividual": 1, "ThresholdEntity": 1, "LegalEntity": null, "DBAName": 0, "Surname": 0, "Firstname": 0, "Address1": 0, "OFACCity": 0, "OFACState": 0, "OFACPostalCode": 0, "OFACCountry": 0, "PlaceOfBirth": 0, "DateOfBirth": 0, "IDNumber": 0, "IDCountry": 0, "OFACNotificationEmail": null, "OFACSMS": null, "OFACStatus": 1010, "OfacRecheckStatus": 1011, "MaxNumberofResults": 30, "ExtendedKeysOnOff": 1, "ComparisonType": 1, "SearchRange": 0, "MatchingThreshold": 80, "SearchType": 0, "ISTWatchItmToQryFirstName": 1, "ISTWatchItmToQryLastName": 1, "ISTWatchItmToQryMidName": 1, "ISTWatchItmToQryAddress": 1, "ISTWatchItmToQryCity": 1, "ISTWatchItmToQryState": 1, "ISTWatchItmToQryCountry": 1, "BillingCycleMethod": 0, "DaysinBillingCycle": 10, "SetBillingCycleTo": 0, "ProcessOnSun": 0, "ProcessOnMon": 1, "ProcessOnTues": 1, "ProcessOnWed": 1, "ProcessOnThur": 1, "ProcessOnFri": 1, "ProcessOnSat": 0, "Holiday1": "01/16/2017 00:00:00", "Holiday2": "02/20/2017 00:00:00", "Holiday3": "05/29/2017 00:00:00", "Holiday4": "07/04/2017 00:00:00", "Holiday5": "09/04/2017 00:00:00", "Holiday6": "10/09/2017 00:00:00", "Holiday7": "11/11/2017 00:00:00", "Holiday8": "11/23/2017 00:00:00", "Holiday9": null, "Holiday10": null, "Holiday11": null, "Holiday12": null, "Holiday13": null, "Holiday14": null, "Holiday15": null, "Holiday16": null, "Holiday17": null, "Holiday18": null, "Holiday19": null, "Holiday20": null, "Holiday21": null, "Holiday22": null, "Holiday23": null, "Holiday24": null, "DayLightSaving": 1, "ProcessingDayEndTime": "07/24/2020 23:59:57", "CurrentProcessingDayEnd": "01/17/2017 23:59:57", "NewProcessingDayEnd": "01/17/2017 23:59:57", "CBLastAppCheck": 0, "CBAppPurge": 0, "MemberCode": null, "SubscriberPassword": null, "CountryCode": 1, "LanguageIndicator": "1", "BureauMarket": null, "BureauSubmarket": null, "IndustryCode": null, "PrdtCode": null, "ProcessingRequest": null, "AddonProductCode": null, "ProductType": "P", "EnableCBR": 1, "ReporterName": "Final, Inc", "ReporterAddress": "PO Box 543000 Omaha, NE 68154", "ReporterTelephone": "8555525375", "CBRIDNumber": "2647210", "ProgramIdInnovis": "", "ProgramIdEquifax": "", "ProgramIdExperian": "DBORX", "ProgramIdTransUnion": "", "CBRReportBy": 0, "DDActiveOrg": 1, "DDFrequency": 0, "DDDaysBeforeCycle": null, "DDMaxNSFAttempts": 3, "DirectDebitResponse": 0, "ACHFormat": 0, "DDOrigBank": null, "DDCompanyName": null, "RTDestinationNo": null, "RTOrignationNo": null, "CompanyAccountNo": null, "CompanyEntryDD": null, "DDPaymentTranCode": null, "DDDirectPayTranCode": null, "DDRevTranCode": null, "DDNSFRevTranCode": null, "CSRPaymentTrnCode": null, "CSRSSPaymentTrnCode": null, "CSRMiniPayment": 0.0, "CSRSSMiniPayment": 0.0, "CSRMaxPayment": 30000.0, "SelfServiceMaxPayment": 30000.0, "DCActiveOrg": 1, "DCPurchaseTranCode": null, "DCRevTranCode": null, "DCReturnTrahnCode": null, "LockboxNo": null, "LockboxABANo": null, "LockboxOriginABA": null, "LockboxAccntNo": null, "InboundRate": null, "TransferRate": null } } } }
Get Credit Plan Master
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetCreditPlanMaster
Use this API to obtain details of the credit plan master available in the system, such as high or low-interest rates, minimum and maximum authorization amounts, numbers of grace days, payment controls, fees, and interest rates.
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 |
PlanMasterID integer Mandatory |
Code associated with the Credit plan.. Valid Values: Code shared by the Corecard. Example: 601 |
MerchantID integer Mandatory |
Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
ParentCreditPlanMasterID integer Optional |
Code associated with the parent Credit plan. Valid Values: Code shared by the Corecard. Example: 601 |
ProductType integer Optional |
a description of the type of card being processed. Valid Values: Code shared by the Corecard. Example: 601 |
MonetaryTransactionControlGroup integer Optional |
Group of transaction code's applicable for the Plan. Valid Values:Corecard will share the value. Example: 2332 |
PrimaryCurrencyCode string Optional |
3 digit Code assiciated with the Currency Valid Values: Refer' Primary Currency Code' section of Appendix Format: XXX Example: 840 Allowable Values: 3 |
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, "PlanMasterID": 6053, "MerchantID": 11607, "ParentCreditPlanMasterID": null, "ProductType": null, "MonetaryTransactionControlGroup": null, "PrimaryCurrencyCode": "" }
Response fields detail
Fields | Description |
---|---|
creditPlanMasterDetails
|
creditPlanMasterDetails |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "CreditPlanMasterDetails": { "PlanMasterID": 6053, "PlanMasterDescription": "12 Months No Interest if Paid in Full", "PrimaryCurrencyCode": "US Dollar", "ParentCreditPlanMasterID": "Template Record", "MerchantID": 11607, "ProductType": "Bankcard", "MonetaryTransactionControlGroup": 78, "MerchantRateTableName": "Template Record", "GeneralControlsList": { "PlanType": 0, "SingleAuthorizationMinimum": 200.0, "SingleAuthorizationMaximum": 25000.0, "MultipleSales": 1, "PreviousCycleGrace": "0", "GraceDaysApplication": 3, "InterestOnGraceReactivation": 1, "InterestPlanOccurrence": 2, "InterestPlanOverride": null, "IntPlanOverridePeriod": null, "CardScheme": "0", "PreAuthAndAuthVarience": null, "PreAuthAging": null, "PreAuthAgingTimeFrame": null, "PreAuthAgingApproved": null, "PreAuthAgingDeclined": null, "AuthAgingEntry": null, "AuthAgingTimeFrame": null, "AuthAgingApproved": null, "AuthAgingDeclined": null, "PlanStructure": 1, "HighInterestRate": null, "LowInterestRate": 29.99, "CustomerRecieptInformationText": "No Interest if Paid in Full Within <Term> Months. Beginning with 1st transaction, <Term> month promo period with payments of <Required Minimum Percent> of the transaction amount. Interest charged to account is waived if entire purchase balance is paid before end of promo period. Making initial minimum required payments will not pay off loan. <HighBalance> APR fixed for life of loan.", "MCCPlan": "", "MCCAccountNumber": "", "TrancodeGroup": null, "TranCodeGroupMCCAccountNumber": "", "CatalogCode": null, "ActivityRecapChannel1": 0, "ActivityRecapChannel2": 0, "ActivityRecapChannel3": 0, "ActivityRecapChannel4": 0 }, "PaymentControls": { "PaymentControllingPlan": 0, "PaymentType": 8, "FixedPaymentAmt": null, "FixedPaymentPercent": 3.25, "MinPaymentType": 2, "MinPaymentPercent": 3.15, "MinPaymentAmount": 0.0, "EqualPayments": null }, "AddOnToEqualPayments": { "GeneratePaymentRequest": null, "Interest": null, "TransactionFees": null, "AnnualFees": null, "LateFees": null, "InsufficientFundsFees": null, "CollectionFees": null, "Insurance": null, "OverLimitFees": null, "RecoveryFees": null }, "PaymentPriority": 1, "OverPaymentPriority": 1, "UnderPaymentPriority": 1, "LastPaymentVariance": { "LastPaymentVarianceType": null, "LastPaymentVarianceAmount": null, "LastPaymentVariancePercentage": null }, "PaymentMatrix": { "PaymentMethod1": 0, "PlanBalance1": null, "PaymentAmount1": null, "PlanPercentage1": null, "PaymentMethod2": 0, "PlanBalance2": null, "PaymentAmount2": null, "PlanPercentage2": null, "PaymentMethod3": 0, "PlanBalance3": null, "PaymentAmount3": null, "PlanPercentage3": null, "PaymentMethod4": 0, "PlanBalance4": null, "PaymentAmount4": null, "PlanPercentage4": null, "PaymentMethod5": 0, "PlanBalance5": null, "PaymentAmount5": null, "PlanPercentage5": null, "PaymentMethod6": 0, "PlanBalance6": null, "PaymentAmount6": null, "PlanPercentage6": null, "PaymentMethod7": 0, "PlanBalance7": null, "PaymentAmount7": null, "PlanPercentage7": null, "PaymentMethod8": 0, "PlanBalance8": null, "PaymentAmount8": null, "PlanPercentage8": null, "PaymentMethod9": 0, "PlanBalance9": null, "PaymentAmount9": null, "PlanPercentage9": null, "PaymentMethod10": 0, "PlanBalance10": null, "PaymentAmount10": null, "PlanPercentage10": null, "PlanBalance11": null, "PaymentAmount11": null, "PlanPercentage11": null, "PaymentMethod11": null, "PlanBalance12": null, "PaymentAmount12": null, "PlanPercentage12": null, "PaymentMethod13": null, "PlanBalance13": null, "PaymentAmount13": null, "PlanPercentage13": null, "PaymentMethod14": null, "PlanBalance14": null, "PaymentAmount14": null, "PlanPercentage14": null, "PaymentMethod15": null, "PlanBalance15": null, "PaymentAmount15": null, "PlanPercentage15": null, "PaymentMethod16": null, "PlanBalance16": null, "PaymentAmount16": null, "PlanPercentage16": null, "PaymentMethod17": null, "PlanBalance17": null, "PaymentAmount17": null, "PlanPercentage17": null, "PaymentMethod18": null, "PlanBalance18": null, "PaymentAmount18": null, "PlanPercentage18": null, "PaymentMethod19": null, "PlanBalance19": null, "PaymentAmount19": null, "PlanPercentage19": null, "PaymentMethod20": null, "PaymentAmount20": null, "PlanBalance20": null, "PlanPercentage20": null }, "DeferredInterestOptions": { "InterestDeferPeriod": 0, "DeferInterestNumberofCycles": 13, "DeferInterestNumberofDays": null, "DeferInterestExpDate": null, "InterestDisposition": 0, "MonetaryTransactionControlGroupName": "GreenSky MTCG", "DeferredExpiredInterestBillingTranCode": 27078, "DeferredCancelledInterestBillingTranCode": 27078, "RollOverReq": 1, "RollCPMDays": null, "RollInterestBNPintoPrincipal": 0 }, "DefermentCancellationOptions": { "DefermentCancelType": "", "DefermentCancelLevel": "", "DefermentCancelMethod": null }, "DeferredPaymentOptions": { "PaymentDefermentPeriod": null, "DeferPaymentNumberofCycles": null, "DeferPaymentNumberofDays": null, "DeferPaymentExpirationDate": null }, "PenaltyPricing": { "PenaltyPricingInterestPlanOccurrence": null, "PenaltyPricingLetter": null, "PenaltyPricingEmail": null, "PenaltyPricingSMS": null }, "PenaltyPricingMethods": { "Option1PenaltyPricingWhenCycleLevelPastDue": null, "Option2PenaltyPricingWhenCycleLevelPastDue": null, "ForConsecutiveCycles": null }, "PenaltyPricingCure": { "WhenCycleLevelPastDue": null, "PenaltyPricingCureForConsecutiveCycles": null }, "PromotionalControls": { "PromoPlanType": null, "PromoPlanOfferCode": null, "PlanOfferCheckCode": null, "PromoPurchaseTxnCategory": null, "PromoPurchaseTxnAmount": null }, "PromotionalRateDurationSettings": { "PromoIntRatePlan": null, "PromoRateStartOn": null, "PromoStartDate": null, "PromoRateEndDate": null, "PromoRateDuration": null, "PromoEndTiming": null, "PromoEndMsg": null }, "PromoTxnWindowSettings": { "PromoTxnWindow": null, "PromoTxnPeriodWindowStartOn": null, "PromoTxnPeriodStartDate": null, "PromoTxnPeriodEndDate": null, "PromoTxnPeriodDuration": null }, "PromotionalTurnOffSettings": { "PromoDelinqDaysTurnOff": null, "PromoDelinqTurnOffNotification": null, "PromoDelinqTurnOffMsg": null }, "PromotionalEndInterestRateSettings": { "RolloverBalancePlan": null, "DefaultBalancePlan": null } } } } }
Get Control ID By Merchant
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetControlIdByMerchant
Use this API to get the list of control parameters for merchants like interest plan, billing table, 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 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 |
MerchantID integer Mandatory |
Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
ControlName string Mandatory |
Control name to get its details like Interest Plan, Billing Table on a product. Valid Values: PlanMaster BillingTable SCharge InterestPlan AControl Format:XXXX Example:Billing Table, Interest Plan 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, "MerchantID": 7031, "ControlName": "BillingTable" }
Response fields detail
Fields | Description |
---|---|
ControlIDByMerchantIDetails array |
List of all the controls defined on Merchant. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ControlIDByMerchantIDetails": [ { "ControlNameCode": 1231, "ControlNameDescription": "Final001" }, { "ControlNameCode": 1241, "ControlNameDescription": "FinalCash" } ] } } }
Get Merchant Category Code Details
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetMCCCategoryDetails
Use this API to find MCC belongs to which MCC category and its 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 |
MCCCategoryCode string Mandatory |
Code of the Merchant Category Code Category Valid Values:Refer 'Merchant Category Code List' section of the Appendix sheet. Example: 3008 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, "MCCCategoryCode": "0000" }
Response fields detail
Fields | Description |
---|---|
MCCList array |
List of all MCC's present under the selected category. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MCCList": [ { "MCCCategoryName": "Airlines", "MCC": "0000", "MCCDescription": "None", "MCCStatus": "Active" } ] } } }
Get Service Charges
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetServiceCharges
Use this API to obtain all fees configured on service charges linked to a merchant 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 |
MerchantID integer Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489 |
ServiceChargePlanID integer Mandatory |
get or set SChargeAcctID |
PrimaryCurrencyCode string |
3 digit Code assiciated with the Currency Valid Values: Refer Primary Currency Code section of Appendix Format: XXX Example: 840 Allowable Values: 3 |
MTCG integer |
get or set MTCG |
SChargeParentId integer |
get or set SChargeParentId |
DefaultCreditPlanID integer |
get or set DefaultCreditPlanID |
TransactionFeeDefaultCreditPlanID integer |
get or set TransactionFeeDefaultCreditPlanID |
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, "MerchantID": 11607, "ServiceChargePlanID": 613, "PrimaryCurrencyCode": null, "MTCG": null, "SChargeParentId": null, "DefaultCreditPlanID": null, "TransactionFeeDefaultCreditPlanID": null }
Response fields detail
Fields | Description |
---|---|
ServiceChargeDetails
|
serviceChargeDetails |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ServiceChargeDetails": { "ServiceChargePlanName": 613, "PrimaryCurrencyCode": "US Dollar", "ServiceChargePlanParentName": "Template Record", "MonetaryTransactionControlGroup": 78, "DefaultCreditPlanName": "GreenSky_Regular_revolving", "TransactionFeesDefaultCreditPlanName": "Use Default Credit Plan Name", "MerchantId": 11607, "DefaultRecoveryFeeCreditPlanName": "GreenSky_Regular_revolving", "TierCriteriaAccountBalanceUnder": null, "LateFeeTiming": 2, "LateFeeBaseDate": 0, "LateFeeDays": 10, "LateFeeDelinquencyCycle": 2, "MaximumNumberLateFeesOption": 0, "LateFeeConsecutiveLimit": 6, "LateFeeMinimumBalance": 0.0, "LateFeeMinimumAmount": 0.0, "LateFeeMaximumAmount1": 27.0, "LateFeeMaximumYearToDate": 9999.0, "MaximumNumberLateFees": "12", "LateFeeTransactionCode": 26681, "LateFeeMaximumAmount2": 38.0, "MaximumAmount2Criteria": 5, "LateFeeCalculationBasis": 6, "LateFeePercent": 0.0, "LateFeeAmount": 0.0, "LateFeePercentMethod": null, "BalanceSubjecttoLateFeeControl": 0, "InsuranceBilledNotPaid": 0, "CollectionFeeBilledNotPaid": 0, "interestBilledNotPaid": 0, "TransactionFeesBilledNotPaid": 0, "LateFeeBilledNotPaid": 0, "AnnualFeeBilledNotPaid": 0, "OverlimitFeeBilledNotPaid": 0, "RecoveryBilledNotPaid": 0, "InsufficientFundsFeeBilledNotPaid": 0, "FeeLevel": "Account", "WaiveFirstLateFee": "No", "TierCriteriaAccountBalanceOverTier2": null, "TierCriteriaAccountBalanceUnderTier2": null, "LateFeeTimingTier2": null, "LateFeeBaseDateTier2": null, "LateFeeDaysTier2": null, "LateFeeDelinquencyCycleTier2": null, "MaximumNumberLateFeesOptionTier2": null, "LateFeeConsecutiveLimitTier2": null, "LateFeeMinimumBalanceTier2": null, "LateFeeMinimumAmountTier2": null, "LateFeeMaximumAmount1Tier2": null, "LateFeeMaximumAmount2Tier2": null, "MaximumAmount2CriteriaTier2": null, "LateFeeMaximumYearToDateTier2": null, "MaximumNumberLateFeesTier2": null, "LateFeeTransactionCodeTier2": 26681, "LateFeeCalculationBasisTier2": null, "LateFeePercentTier2": null, "LateFeeAmountTier2": null, "LateFeePercentMethodTier2": null, "BalanceSubjecttoLateFeeControlTier2": null, "InsuranceBilledNotPaidTier2": null, "CollectionFeeBilledNotPaidTier2": null, "InterestBilledNotPaidTier2": null, "TransactionFeesBilledNotPaidTier2": null, "LateFeeBilledNotPaidTier2": null, "AnnualFeeBilledNotPaidTier2": null, "OverlimitFeeBilledNotPaidTier2": null, "RecoveryBilledNotPaidTier2": null, "InsufficientFundsFeeBilledNotPaidTier2": null, "TierCriteriaAccountBalanceOverTier3": null, "LateFeeTimingTier3": null, "LateFeeBaseDateTier3": null, "LateFeeDaysTier3": null, "LateFeeDelinquencyCycleTier3": 1, "MaximumNumberLateFeesOptionTier3": null, "LateFeeConsecutiveLimitTier3": null, "LateFeeMinimumBalanceTier3Tier3": null, "LateFeeMinimumAmountTier3": null, "LateFeeMaximumAmount1Tier3": null, "LateFeeMaximumAmount2Tier3": null, "MaximumAmount2CriteriaTier3": null, "LateFeeMaximumYearToDateTier3": null, "MaximumNumberLateFeesTier3": null, "LateFeeTransactionCodeTier3": null, "LateFeeCalculationBasisTier3": null, "LateFeePercentTier3": null, "LateFeeAmountTier3": null, "LateFeePercentMethodTier3": null, "BalanceSubjecttoLateFeeControlTier3": null, "InsuranceBilledNotPaidTier3": null, "CollectionFeeBilledNotPaidTier3": null, "InterestBilledNotPaidTier3": null, "TransactionFeesBilledNotPaidTier3": null, "LateFeeBilledNotPaidTier3": null, "MembershipFeeBilledNotPaidTier3": null, "OverlimitFeeBilledNotPaidTier3": null, "RecoveryBilledNotPaidTier3": null, "InsufficientFundsFeeBilledNotPaidTier3": null, "OverlimitTiming": 0, "OverlimitFeeMaximumAmount1": 0.0, "OverlimitFeeMaximumAmount2": null, "OverlimitFeeMinimumAmount": 0.0, "OverlimitFeesMaximumYearToDate": 0.0, "OverlimitFeeMaximumAmount2Criteria": null, "OverLimitFeeTrancode": 26685, "OverlimitFeeCalculationBasis": 0, "OverlimitFeeAmount": 0.0, "OverlimitPercent": 0.0, "AllowedOverlimitPercent": 0.0, "OverlimitFeesMaximumCycleToDate": null, "InsufficientFundsFeeCalculationBasis": 6, "InsufficientFundsFeeAmount": 20.0, "InsufficientFundsFeePercent": 0.0, "InsufficientFundsFeeMaximum1": 20.0, "InsufficientFundsFeeMaximum2": null, "InsufficientFundsFeeMaximumAmount2Criteria": null, "InsufficientFundsFeeMinimum": 0.0, "InsufficientFundsFeeTrancode": 26678, "WaiveFirstAnnualFee": 1, "AnnualFeeType": 0, "AnnualFeeCardholderOptions": null, "DefaultAnnualPlan": 0, "AnnualFeeMonth": 0, "AnnualFeeAmountPrimary": 0.0, "AnnualFeeAmountSecondary": 0.0, "AnnualFeeTransactionCode": null, "TransactionFeesList": null, "AuthorizationFeesList": null, "CardFeesList": null, "ActiveFeesList": null, "ServiceFeesList": null, "ManualFeesList": null, "MessageFeesList": null, "FeeGroupList": [ { "FeeGroupAcctid": "GreenSky Fee Group", "FeeGroupPriority": "1", "MaxNumberOfFeesPerDay": "1", "MaxNumberOfFeesPerMonth": null, "MaxNumberOfFeesPerCycle": "1", "MaxNumberOfFeesPerYear": "12", "MaxFeesCycleToDate": 9999.0, "AccountToBeInactiveForMinimum": null, "FeeGroupPeriod": null } ] } } } }
Get Statement Message Groups
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetStatementMessageGroups
Use this API to get the list of the statement message groups created under an 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 |
StatementMessageGroupCode string Optional |
Code of the statement message group which is created to group all the statement messages. Valid Values: Code which is generated with ManageStatementMessageGroup API or get this via GetStatementMessageGroup API. Example: 100 Allowable Values: 50 |
StatementMessageGroup string Optional |
Name of Statement Message Group Valid Values:A-Z, 0-9. Example:Name Allowable Values: 100 |
StatementMessageGrpLanguage string Optional |
Selection of language Valid Values: Language == en: means use English ---- es: means Spanish Example:English ---- es: Allowable Values: 30 |
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, "StatementMessageGroupCode": "4", "StatementMessageGroup": null, "StatementMessageGrpLanguage": null }
Response fields detail
Fields | Description |
---|---|
StatementMessageGroupList array |
This array will list all Statement Message group basis the search criteria. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "StatementMessageGroupList": [ { "StatementMessageGroupCode": "4", "StatementMessageGroup": "First Group2", "DisplayOrder": 4, "Language": "dbb" } ] } } }
Get Status Definition
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetStatusDefinition
Use the CoreCARD API to obtain the parameters and configurations that govern the definition of a status applied to a plastic or virtual card.
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 |
AccountStatus integer Mandatory |
Credit Report Details Status Code Valid Values: 0-9 Format: xx Example: 12 |
MerchantID integer Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489 |
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, "AccountStatus": 1, "MerchantID": 11268 }
Response fields detail
Fields | Description |
---|---|
StatusDefinition
|
The list of parameters configured for mentioned status. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "StatusDefinition": { "AccountID": 10804, "StatusDescription": "Template Record", "StatusPriority": 310, "SelfServiceAccess": 0, "IssueReissueAction": 1, "FinanceChargeAction": 2, "RevolvingPaymentAction": 3, "InsuranceCancellationAction": 2, "CreditBureauStatus": "0 ", "CheckOpenToBuy": 1, "PostingOfTransactions": 7, "LoyaltyPointsDeduction": null, "LoyaltyPointsAccumulation": 1, "InsuranceEligibility": 0, "PostingReason": 6, "HoldStatement": null, "WaiveLateChargeAction": 1, "WaiveLateChargeFor": 0, "WaiveLateChargeCyclesFrom": null, "WaiveAnnualFeeAction": 1, "WaiveAnnualFeeActionFor": 0, "WaiveAnnualFeeActionCyclesFrom": null, "WaiveOverlimitFeeAction": 1, "WaiveOverlimitFeeActionFor": 0, "WaiveOverlimitFeeActionCyclesFrom": null, "WaiveInsufficientFundsAction": 1, "WaiveInsufficientFundsActionFor": 0, "WaiveInsufficientFundsActionCyclesFrom": null, "StatementDelivery": "2", "WaiveMinimumDue": 0, "WaiveMinimumDueFor": null, "WaiveMinimumDueCyclesFrom": null, "WaiveInsurancePremiums": 0, "WaiveInsurancePremiumsFor": null, "WaiveInsurancePremiumsCyclesFrom": null, "WaiveInterest": 1, "WaiveInterestFor": 0, "WaiveInterestCyclesFrom": null, "WaiveTransactionFees": 1, "WaiveTransactionFeesFor": 0, "WaiveTransactionFeesCyclesFrom": null, "WaiveAuthorizationFees": null, "WaiveAuthorizationFeesFor": null, "WaiveAuthorizationFeesCyclesFrom": null, "WaiveCardFees": 0, "WaiveCardFeesFor": null, "WaiveCardFeesCyclesFrom": null, "WaiveActiveInactiveFees": null, "WaiveActiveInactiveFeesFor": null, "WaiveActiveInactiveFeesCyclesFrom": null, "WaiveServiceFees": 1, "WaiveServiceFeesFor": 0, "WaiveServiceFeesCyclesFrom": null, "WaiveMessageFees": 0, "WaiveMessageFeesFor": null, "WaiveMessageFeesCyclesFrom": null, "SchedulePayments": null, "NegativeRewardBalanceToCharge": null, "TrigRewardRedemption": null, "ExRedemptionMethod": null, "RetainGraceStatus": null, "AfterNumberOfCycles": null, "COReasonCode": null, "NewManualStatus": null, "StatusGroup": 0, "ExcludeFromCBR": null, "SendToCollections": 0, "SetDunSuppress": 1, "RestructureActionCode": null, "CloseCaseActionCode": null, "OverridePriority": null, "GenerateEmail": null, "GenerateSMS": null, "GenerateLetter": null } } } }
Get Statement Messages
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetStatementMessages
This API shall be used to get the statement message details.
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 |
SearchCriteria
|
Get or Set SearchCriteria |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch 50 is default value Valid Values:0-9 Format:XX Example:20 |
PageIndex integer Optional |
Number of page. 0 is default value. Valid Values:0-9 Format:XX Example:12 |
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 |
SearchCriteria
|
Get or Set SearchCriteria |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch 50 is default value Valid Values:0-9 Format:XX Example:20 |
PageIndex integer Optional |
Number of page. 0 is default value. Valid Values:0-9 Format:XX Example:12 |
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, "SearchCriteria": { "InstitutionID": 3235, "StatementMessageGroupCode": null, "StatementMessageTypeCode": null, "StatementType": null, "StatementMessageCode": null, "MessagePeriod": null, "LanguageIndicator": null, "CurrentBalance": null, "Priority": null, "LastDigitOfAccountNumber": null }, "BatchSize": null, "PageIndex": null }
Response fields detail
Fields | Description |
---|---|
StatementMessageList array |
Array to list the statement messages. |
StatementMessageList array |
Array to list the statement messages. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "StatementMessageList": [ { "StatementMessageGroupCode": "0", "StatementMessageGroup": "First Group", "LanguageIndicator": "en", "StatementMessageTypeCode": "20", "StatementMessageType": "Generic Message", "StatementType": "7", "StatementTypeName": "All", "StatementMessageCode": "1", "StatementMessage": "LOOKING FOR WEDDING OR ANNIVERSARY BANDS? COME TO MAYORS TO DISCOVER THE PERFECT SYMBOL OF YOUR LOVE.\r\nYOUR ACCOUNT REFLECTED DUE AMOUNT OF <Total Amount Due>. PLEASE REMIT AMOUNT DUE TODAY.<Account Open Date>", "Priority": 1, "CurrentBalance": null, "LastDigitOfAccountNumber": null, "MessagePeriodCode": null, "MessagePeriod": null } ] } } }
Get Product Processing Parameter
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetProductProcessingParameter
Use this API to get the configuration details of the card program. A product ID which is assigned to a cards program is mandatory to provide in the API input. API fetches out parameters and configuration details such as auth result codes, fees detail, status field data, primary currency code, max limit assigned to a product, action codes 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 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 Mandatory |
Description: ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "ProductID": 3405 }
Response fields detail
Fields | Description |
---|---|
Logo
|
get or set Logo |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "Logo": { "ProductName": "GreenSky ECO", "ProductParentName": "Template Record", "ProgramName": null, "PrimaryCurrencyCode": "US Dollar", "ParentInstitution": "GreenSky, LLC", "AccountID": 3405, "CardType": null, "ProgramManager": null, "SubProductType": "35", "BankIdentificationNumber": "888801 = greensky", "AssociationProductType": "MC21", "NumberOfSecondaryIDs": null, "AutomaticallyClose": "YES", "AutoCloseMonths": 12, "PIIRequired": null, "MaximumCreditLimit": 65000.0, "SuppressCreditLimitInStmtOnline": 0, "SuppressCreditLimitInStmtOutgoing": 0, "SuppressOpenToBuyInStmtOnline": 0, "SuppressOpenToBuyInStmtOutgoing": 0, "ProductStatement": "0", "AccruedInterestReporting": "0", "SummaryProduct": 0, "NumberOfStatementMessages": 5, "DuplicateCheckType": 4, "ProductMessageGroup": "1039", "PlanSegmentArchivalMonths": "1", "AccountArchivalMonths": 0, "Status1": "1", "StatusFieldTitle1": null, "StatusFieldData1": null, "Status2": "1", "StatusFieldTitle2": null, "StatusFieldData2": null, "Status3": "1", "StatusFieldTitle3": null, "StatusFieldData3": null, "Status4": "1", "StatusFieldTitle4": null, "StatusFieldData4": null, "Status5": "1", "StatusFieldTitle5": null, "StatusFieldData5": null, "Status6": "1", "StatusFieldTitle6": null, "StatusFieldData6": null, "Status7": "1", "StatusFieldTitle7": null, "StatusFieldData7": null, "Status8": "1", "StatusFieldTitle8": null, "StatusFieldData8": null, "Status9": "1", "StatusFieldTitle9": null, "StatusFieldData9": null, "Status10": "1", "StatusFieldTitle10": null, "StatusFieldData10": null, "Status11": "1", "StatusFieldTitle11": null, "StatusFieldData11": null, "Status12": "1", "StatusFieldTitle12": null, "StatusFieldData12": null, "Status13": "1", "StatusFieldTitle13": null, "StatusFieldData13": null, "Status14": "1", "StatusFieldTitle14": null, "StatusFieldData14": null, "Status15": "1", "StatusFieldTitle15": null, "StatusFieldData15": null, "Status16": "1", "StatusFieldTitle16": null, "StatusFieldData16": null, "Status17": "1", "StatusFieldTitle17": null, "StatusFieldData17": null, "Status18": "1", "StatusFieldTitle18": null, "StatusFieldData18": null, "Status19": "1", "StatusFieldTitle19": null, "StatusFieldData19": null, "Status20": "1", "StatusFieldTitle20": null, "StautsFieldData20": null, "ProductContactFirstName": "", "ProductContactSurname": "", "ProductContactAddressLineOne": "P.O. Box 29429", "ProductContactAddressLineTwo": null, "ProductContactCity": "Atlanta", "ProductContactCountry": "US", "ProductContactStateProvince": "GA", "ProductContactpostalcode": "30359", "CustomerServicePhoneNumber": "844-570-9915", "CollectionsPhoneNumber": "855-381-9523", "FaxNumber": "267-295-1004", "EMailAddress": "service@greenskycredit.com", "CashAdvanceAtATMInquiries": "", "Website": "www.MyGreenSky.com", "MobileWebsite": null, "Privacy": null, "PRemitToName": null, "RAddressLine1": "P.O. Box 2153", "RAddressLine2": "Box/Dept # 3021", "RCity": "Birmingham", "RCountry": "US", "RStateProvince": "AL", "RPostalCode": "35287-3021", "RemitCheckDigit": null, "RLogo": "0 = BankCard", "PGifLocation": null, "RemitToNameOvernight": null, "RAddressLine1Overnight": null, "RAddressLine2Overnight": null, "RCityOvernight": null, "RCountryOvernight": null, "RStateProvinceOvernight": null, "RPostalCodeOvernight": null, "LoadMTDAmount": 0.0, "LoadMTDCount": 0, "DebitsMTDAmount": 0.0, "DebitsMTDCount": 0, "CreditsMTDAmount": 0.0, "CreditsMTDCount": 0, "PaymentsMTDAmount": 0.0, "PaymentsMTDCount": 0, "CashAdvanceMTDAmount": 0.0, "CashAdvanceMTDCount": 0, "PurchasesMTDAmount": 0.0, "PurchasesMTDCount": 0, "CashAdvanceReturnsMTDAmount": 0.0, "CashAdvanceReturnsMTDCount": 0, "PurchaseReturnsMTDAmount": 0.0, "PurchaseReturnsMTDCount": 0, "DisputesMTDAmount": 0.0, "DisputesMTDCount": 0, "NSFReturnsMTDAmount": 0.0, "NSFReturnsMTDCount": null, "SecurityDepositDebitsMTDAmount": 0.0, "SecurityDepositDebitsMTDCount": 0, "SecurityDepositCreditsAmount": 0.0, "SecurityDepositCreditsCount": 0, "InsuranceAmountMTDAmount": 0.0, "TransactionFeesMTDAmount": 0.0, "TransactionFeesMTDCount": 0, "MembershipFeesMTDAmount": 0.0, "MembershipFeesMTDCount": 0, "LateFeesMTDAmount": 0.0, "LateFeesMTDCount": 0, "OverlimitFeesMTDAmount": 0.0, "OverlimitFeesMTDCount": 0, "InsufficientFundsFeesMTDAmount": 0.0, "InsufficientFundsFeesMTDCount": 0, "CollectionFeesMTDAmount": 0.0, "CollectionFeesMTDCount": 0, "RecoveryFeesMTDAmount": 0.0, "NumberRecoveryFeesMTD": 0, "InterestMTDAmount": 0.0, "LoadYTDAmount": 0.0, "LoadYTDCount": 0, "DebitsYTDAmount": 0.0, "DebitsYTDCount": 0, "CreditsYTDAmount": 0.0, "CreditsYTDCount": 0, "PaymentsYTDAmount": 0.0, "PaymentsYTDCount": 0, "CashAdvanceYTDAmount": 0.0, "CashAdvanceYTDCount": 0, "PurchasesYTDAmount": 0.0, "PurchasesYTDCount": 0, "CashAdvanceReturnsYTDAmount": 0.0, "CashAdvanceReturnsYTDCount": 0, "PurchaseReturnsYTDAmount": 0.0, "PurchaseReturnsYTDCount": 0, "DisputesYTDAmount": 0.0, "DisputesYTDCount": 0, "NSFReturnsYTDAmount": 0.0, "NSFReturnsYTDCount": null, "SecurityDepositDebitsYTDAmount": 0.0, "SecurityDepositDebitsYTDCount": 0, "SecurityDepositCreditsYTDAmount": 0.0, "SecurityDepositCreditsYTDCount": 0, "InsuranceYTDAmount": 0.0, "TransactionFeesYTDAmount": 0.0, "TransactionFeesYTDCount": 0, "MembershipFeesYTDAmount": 0.0, "MembershipFeesYTDCount": 0, "LateFeesYTDAmount": 0.0, "LateFeesYTDCount": 0, "OverlimitFeesTYDAmount": 0.0, "OverlimitFeesTYDCount": 0, "InsufficientFundsFeesYTDAmount": 0.0, "InsufficientFundsFeesYTDCount": 0, "CollectionFeesYTDAmount": 0.0, "CollectionFeesYTDCount": 0, "RecoveryFeesYTDAmount": 0.0, "RecoveryFeesYTDCount": 0, "InterestYTDAmount": 0.0, "LoadsLTDAmount": 0.0, "LoadsLTDCount": 0, "DebitsLTDAmount": 0.0, "DebitsLTDCount": 0, "CreditsLTDAmount": 0.0, "CreditsLTDCount": 0, "PaymentsLTDAmount": 0.0, "PaymentsLTDCount": 0, "CashAdvanceLTDAmount": 0.0, "CashAdvanceLTDCount": 0, "PurchasesLTDAmount": 0.0, "PurchasesLTDCount": 0, "CashAdvanceReturnsLTDAmount": 0.0, "CashAdvanceReturnsLTDCount": 0, "PurchaseReturnsLTDAmount": 0.0, "PurchaseReturnsLTDCount": 0, "DisputesLTDAmount": 0.0, "DisputesLTDCount": 0, "NSFReturnsLTDAmount": 0.0, "NSFReturnsLTDCount": null, "SecurityDepositDebitsLTDAmount": 0.0, "SecurityDepositDebitsLTDCount": 0, "SecurityDepositCreditsLTDAmount": 0.0, "SecurityDepositCreditsLTDCount": 0, "InsuranceLTDAmount": 0.0, "TransactionFeesLTDAmount": 0.0, "TransactionFeesLTDCount": 0, "MembershipFeesLTDAmount": 0.0, "MembershipFeesLTDCount": 0, "LateFeesLTDAmount": 0.0, "LateFeesLTDCount": 0, "OverlimitFeesLTDAmount": 0.0, "OverlimitFeesLTDCount": 0, "InsufficientFundsFeesLTDAmount": 0.0, "InsufficientFundsFeesLTDCount": 0, "CollectionFeesLTDAmount": 0.0, "CollectionFeesLTDCount": 0, "RecoveryFeesLTDAmount": 0.0, "RecoveryFeesLTDCount": 0, "InterestLTDAmount": 0.0, "CoreCOLLECTInterfaceIsActive": "1", "SendChargeOffAccounts": "1", "SendAcctForFirstPymtDefault": "1", "CollectionMinBalance": 5.0, "SendAcctForDailyExcessiveUse": "0", "SendAcctForCycleExcessiveUse": "0", "SendDelinquentAccounts": "1", "SendOverlimitAccounts": "0", "SendDelinquencyAndOverlimitAcct": "0", "dailyexecessuse": null, "CycleExcessUse": null, "DelinquencyLevel": "0", "CycleDue": 2, "DaysDelinquent": null, "OverlimitPercentage": 100.0, "OverlimitAmount": null, "RCChargedOff": 2, "RCDelinquent": 4, "RCDelinquentAndOverlimit": 5, "RCExcessiveUse": 7, "RCFirstPaymentDefault": 3, "RCOverlimit": 8, "RCStatusLow": 6, "RCStatusHigh": 1, "ResActionCodeChargeoff": null, "ResActionCodeDeliq": null, "ResActionCodeDeliqOver": null, "ResActionCodeExcUse": null, "ResActionCodeFPD": null, "ResActionCodeOverlmt": null, "CCaseActionCodeChargeoff": null, "CCaseActionCodeDeliq": null, "CCaseActionCodeDeliqOver": null, "CCaseActionCodeExcUse": null, "CCaseActionCodeFPD": null, "CCaseActionCodeOverlmt": null, "DomesticIVRNumber": null, "IVRCardTextEnglish": null, "TransferOutNumberEnglish": null, "IVRCardTextSpanish": null, "TransferOutNumberSpanish": null, "IVRPasswordFormat": "0", "IVRPasswordPolicy": "3", "Reports": [ { "ReportName": null, "ScheduleType": "BUSINESSDATE", "ScheduleTime": null, "DeliveryMethod": "Online", "DeliveryFrequency": "Daily", "FtpAddress": null, "FTPLogin": null, "FtpPassword": null, "EmailAddress": null } ], "ArchivalStatus": null, "AuthorizationDecisionControls": [ { "Priority": 1, "ControlID": "101101", "Category": "Card Number", "RuleDescription": "Card Number Check", "ResponseCode": "03 = Invalid Card Number", "Action": "14=Invalid PAN", "OmitForVIPCard": 0, "Status": "Active", "BaseFlag": 1 } ], "AuthResultCodes": [ { "FiveDigitZIPCodeReceived": "Yes", "NineDigitZIPCodeReceived": "No", "ZIPCodeMatched": "Yes", "AddressDataReceived": "Yes", "AddressMatched": "Yes", "MDSAVSResultCode": "Y", "VisaAVSResultCode": "Y", "DiscoverAVSResultCode": "A", "MasterCardAVSResultCode": "Y", "vantivAVSResultCode": "Y", "VantivAVSWithPurchaseADCResponse": null, "VantivAVSOnlyADCResponse": null, "MDSAVSWithPurchaseADCResponse": null, "DiscoverAVSWithPurchaseADCResponse": null, "VisaAVSWithPurchaseADCResponse": null, "MDSAVSWithAccountStatusADCResponse": null, "DiscoverAVSOnlyADCResponse": null, "VisaAVSOnlyADCResponse": null } ], "HoldPayments": null, "StatusMessages": [ { "StatusCategory": "Card", "AccountStatus": "Template Record", "ActiveFlag": "Active", "CardHolderUpdate": "No", "SubjectToFees": "Yes", "Frequency": null, "MessageType": "E-mail", "MessageTemplate": "GreenSky - StatusCardActive", "TemplateVersionID": "2", "Language": "English (United States)", "SelfServiceGroup": "GS : StatusCardActive" } ], "PeriodMessages": [ { "Timing": null, "BeginDate": "01/13/2017 23:20:14", "EndDate": null, "ActiveFlag": "Inactive", "CardHolderUpdate": "No", "SubjectToFees": "Yes", "MessageType": "E-mail", "MessageTemplate": "PeriodAvailableBalance", "TemplateVersionID": "1", "Language": "English (United States)", "SelfServiceGroup": "GreenSky: Available Balance" } ], "MonetaryMessages": null, "SecurityMessages": [ { "SecurityCategory": "Address Change", "ActiveFlag": "Active", "CardHolderUpdate": "Yes", "SubjectToFees": "Yes", "MessageType": "Letter", "MessageTemplate": null, "TemplateVersionID": "1 ", "Language": "English", "SelfServiceGroup": null } ], "CardMessages": [ { "CardCategory": "Issued", "CardSubCategory": "Secondary", "ActiveFlag": "Inactive", "CardHolderUpdate": "No", "SubjectToFees": "Yes", "MessageType": "E-mail", "MessageTemplate": "CardsIssuedPrimary", "TemplateVersionID": "1", "Language": "English (United States)", "SelfServiceGroup": "GreenSky: Card Issued" } ], "PaymentParameters": { "ApplicationOfPaymentsMethod": 1, "PlanPaymentMethod": 5, "OverpaymentApplication": 1, "DeferredPlanExpirationThreshold": 2, "ReturnsCreditsBehavior": 0, "OtherCreditsForInterestGrace": 0, "PrepaymentActive": 0, "PrepaymentCycles": 0, "CheckPaymentsTranCode": 26693, "eCheckPaymentsTranCode": 27019, "PaymentVarianceMethod": 0, "PaymentVarianceAmount": 0.0, "AutoPayoffTrigger": 0, "PaymentVariancePercentage": 0.0, "PayoffVarianceMethod": 0, "PayoffVarianceAmount": 0.0, "PayoffVariancePercent": 0.0, "PayOffVarianceMaximum": 0.0, "NSFReversalTransactionCode": 26696, "PaymentHierarchyInterest": 1, "PaymentHierarchyTransactionFees": 4, "PaymentHierarchyLateFees": 2, "PaymentHierarchyInsufficientFundsFees": 3, "PaymentHierarchyPendingInterest": 11, "PaymentHierarchyPendingTransactionFees": 12, "PaymentHierarchyPendingLateFees": 13, "PaymentHierarchyPendingInsufficientFundsFees": 14, "PaymentHierarchyOverlimitFees": 5, "PaymentHierarchyInsurancePremiums": 6, "PaymentHierarchyCollectionExpenses": 7, "PaymentHierarchyRecoveryExpenses": 8, "PaymentHierarchyPendingOverlimitFees": 15, "PaymentHierarchyPendingInsurancePremiums": 16, "PaymentHierarchyPendingCollectionExpenses": 17, "PaymentHierarchyPendingRecoveryExpenses": 18, "PaymentHierarchyAnnualFees": 9, "PaymentHierarchyBalanceSubjectToFinanceCharge": 1, "PaymentHierarchyPrincipal": 10, "PaymentHierarchyCurrentCyclePurchases": 0, "PaymentHierarchyPendingAmountFees": 19, "PaymentHierarchyCurrentCycleFees": 0, "PaymentHierarchyFirstCycleOverride": null, "AutoInitialChargeOffInitial": 8, "AutoFinalCO": 0, "AutoInitialCOfrequency": 1, "FinalStatement": 0, "CONumber": 0, "AutoFinalCOFrequency": 1, "TimingOption": 1, "COCreditBalRefund": 1, "COInterest": 1, "COTranFees": 10, "COLateFees": 2, "COInsufficientFundsFees": 3, "COOverlimitFees": 5, "COInsurancePremiums": 6, "COCollectionExpenses": 7, "CORecoveryExpenses": 8, "COAnnualFees": 9, "COPrincipal": 4, "DebitWriteOffHighBalance": 5.0, "DebitWriteOffLowBalance": 0.01, "DebitWriteOffFrequency": 1, "DebitWriteOffDays": 90, "WriteOffBalanceUpdateOption": 0, "CreditWriteOnHighBalance": 0.01, "CreditWriteOnLowBalance": 1.0, "CreditWriteOnFrequency": 1, "CreditWriteOnDays": 90, "WriteOnBalanceUpdateOption": 0, "CreditBalancePlanName": 6049, "CreditBalanceRefundOptions": 2, "CreditBalanceRefundHighBalance": 1.01, "CreditBalanceRefundLowBalance": 5.0, "RefundCheckFrequency": 1, "CreditBalanceDays": 32, "RefundCheckDayOfMonth": null, "CBRBalanceUpdateOption": 0, "PreRefundReportDays": null, "RefundReviewThreshold": null, "AutoCreditBalanceRefundTranCode": 27137, "ManualCreditBalanceRefundTranCode": 27138, "ACHRefundReturnTranCode": 27139, "CNCardNumberAutoGenerateFlag": "0", "CNCardholderNumberGenerationLevel": "2", "CNCardNumberParent": null, "CNCardType": null, "CNCardTechnology": "Magnetic Stripe", "CardNbrBegin": "8888015000000001", "CardNbrEnd": "8888019999999999 ", "CardNbrIncrementBy": 1, "CardNbrLastUsed": "888801******0012", "CNCheckDigit": "1", "CardNbrAlertTrigger": 1, "CardNbrAlertCounter": 899992, "LastUsedCardNumber": "888801******0012", "CardNumberGenerationMethod": "0", "DirectDebitActive": "1", "DirectDebitPaymentTxnCode": null, "DirectDebitDirectedPaymentTxnCode": null, "DirectDebitResponse": "0", "DirectDebitNotificationDays": null, "CSRPanelPaymentTxnCode": null, "SelfServicePaymentTxnCode": null, "MinimumCSRPayment": 0.0, "MinimumSelfServicePayment": 0.0, "MaximumCSRPayment": 30000.0, "MaximumSelfServicePayment": 30000.0, "DirectCreditActive": "1", "DirectCreditPurchaseTransactionCode": null, "DirectCreditPurchaseReversalTxnCode": null, "DirectCreditReturnTransactionCode": null, "ReportToCreditBureau": "1", "CBRXMonths": null, "CBRXDaysDelinquent": 30, "IncludeFrom": null, "IncludeTo": null }, "StatementMessageGroup": null, "QMRReportChannelID": null, "CardTechnology": null, "MonetaryTransactionControlGroup": null, "BillingGroup": null, "DefaultBillingTable": null, "ErrorNotificationEmail": null, "ProductRestrictions": null, "FundingRestrictions": null, "ReageFrequency": null, "NoReageAfter": null, "ReageMax": null, "ReageTimeframe": null, "ACHProcessing": null, "ACHPaymentTransactionCode": null, "ACHProcessingLevel": null, "ACHPaymentReversalTxnCode": "26694", "ACHPymtNSFReversalTxnCode": "26696", "AdjustReserveAmountOnLoad": "0", "LoadTransactioncode": "0", "ReserveODVariance": 0.0, "LanguagePreference": null, "LetterBankName": "Midland States Bank of Effingham, IL", "LetterFullProgramName": "GreenSky ", "LetterShortProgramName": "GreenSky ", "LetterAddressName": "1313 N. Market Street, Suite 5100", "LetterPhone": " 844-810-7713", "LetterTeamName": "GreenSky ", "LetterEmail": "support@GreenSky.com", "LetterMinScore": 250, "LetterMaxScore": 900, "LetterBureau": null, "LetterClosingNotice": null, "ActivityRecapChannel1": null, "ActivityRecapChannel2": null, "ActivityRecapChannel3": null, "ActivityRecapChannel4": null, "PaymentWarningOption": "1", "MinimumInterestFeeTxnCode": "27108", "PrepayAmtTranCode": null, "AddDisbTranCode": "", "IntAdjTranCode": "27052", "LateAdjFeeTranCode": "26682", "NSFFeeAdjTranCode": "26679", "DisputeRequestBoundary": "365", "DisputeResolutionBoundary": null, "AutoResolutionDecision": 0, "DisputeReversalBoundary": "60", "DisputePurchaseRevTranCode": "27205", "DisputePurchaseTranCode": "27405", "RegZFirstYearCapLimit": null, "MLACapLimit": null, "SCRACapLimit": null, "NumberofTransactionsLimit": null, "UniqueStoreCheck": null, "Loyalty": null, "Embossing": null, "DirectDebitPaymentAmount": null, "BackdatedDebitsMethod": null, "BackdatedDebitsDays": null, "BackdatedCreditsMethod": null, "BackdatedCreditsDays": null, "OverlimitTolerance": null, "TransferFrom": null, "TransferTo": null, "IncludeReturnAuthInOTBCalculation": null, "IncludeCreditBalancesInOpenToBuy": null, "IncludeDisputesInOpenToBuy": null, "MaxPurchasesCTD": null, "MaxCashCTD": null, "PercentReturnofPurchasesYTD": null, "PercentReturnofPurchasesLTD": null, "NewCardSpendingLimit": null, "NewCardTimePeriod": null, "AllowTokenTxnOnPrimaryCard": null, "AllowTokenTxnOnSecondaryCard": null, "AllowTokenTxnOnVirtualCard": null, "PINTryLimit": null, "AgingLevel": null, "AuthVariance": null, "PreAuthAging": null, "PreAuthorizationAgingTimeFrame": null, "PreAuthAgingApprovedDisplay": null, "PreAuthAgingDeclinedDisplay": null, "AuthAging": null, "AuthorizationAgingTimeFrame": null, "AuthAgingApprovedDisplay": null, "AuthAgingDeclinedDisplay": null, "PurchaseZIPandAddressMatch": null, "PurchaseAddressMatchandZIPNotMatch": null, "PurchaseZIPMatchandAddressNotMatch": null, "PurchaseZIPandAddressNotMatch": null, "PurchaseAddressInfoNotAvailable": null, "AVSonlyZIPandAddressMatch": null, "AVSonlyAddressMatchandZIPNotMatch": null, "AVSonlyZIPMatchandAddressNotMatch": null, "AVSonlyZIPandAddressNotMatch": null, "AVSonlyAddressInfoNotAvailable": null, "AVSDataFormat": null, "AddressAnd9DigitZipMatch": null, "AddressAnd5DigitZipMatch": null, "AddressMatchZipDoesNotMatch": null, "NineDigitZIPMatchAddrDoesNotMatch": null, "FiveDigitZIPMatchAddrDoesNotMatch": null, "AddressAndZipDoNotMatch": null, "AddressInfoIsUnavailable": null, "SystemIsUnavailable": null, "ServiceNotSupported": null, "ErrorTxnIsUneligible": null, "AddrVerificationHasNotBeenPerformed": null } } } }
GetLoyaltyRuleQualifiedDetails
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyRuleQualifiedDetails
This API is to show the details of Loyalty Rule setup for the transaction of an 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 Example:12345 Condition : At least one Account identifier input parameter should be passed. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition : At least one Account identifier input parameter should be passed. Allowable Values: 19 |
AuthTranID string Conditional |
Authrorization Transaction ID,to identify we need to decline it or approve it. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:12343235235235 Condition:Either ClearingTranID or AuthTranID can be pass. Allowable Values: 19 |
ClearingTranID string Conditional |
Clearing Transaction ID Valid Values: 0-9 Format:XXXXXXXXX Example:123654789 Condition:Either ClearingTranID or AuthTranID can be pass. 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, "AdminNumber": null, "AccountNumber": "9110000000000073", "AuthTranID": "123372036854851858", "ClearingTranID": "123372036854851858" }
Response fields detail
Fields | Description |
---|---|
AccountNumber string |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
QualifiedRuleInPreAuth
|
QualifiedRuleInPreAuth |
QualifiedRuleInClearing
|
QualifiedRuleInClearing |
Sample response body
SetLoyaltyRuleForLoyaltyProgram
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/SetLoyaltyRuleForLoyaltyProgram
This API is used to Update or map loyalty rule to the loyalty program.
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 |
LoyaltyProgramID integer Mandatory |
ID of Loyalty Program Valid Values:0-9 Format:XXXX Example:2345(Value shared by Corecard). |
DecisionFlag integer Mandatory |
Decide the activity need to perform. 1 = Mapped Rule Id for Loyalty Program 2 = Updated Rule ID Example:1 |
RuleID integer Mandatory |
ID of LoyaltyRule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234 |
Priority integer Conditional |
Decided the priority of loyalty rule. Valid Values: 0-9 Example: 1 Condition: Priority is required if Decisionflag is "1" |
Status integer Optional |
A loyalty rule is considered for the evaluation only when its status is Active at both the places i.e. on Loyalty Rule Setup and on Rule Mapping on Loyalty Program. Valid Values: Active Inactive Example: Active Condition: Default value would be Active |
StartDate datetime Conditional |
A loyalty rule is considered for the evaluation only when its status is Active at both the places i.e. on Loyalty Rule Setup and on Rule Mapping on Loyalty Program.This is a conditional field where if required the user can provide a future date from where the rule in context should start evaluating the loyalty. Valid Values: Format: MM/DD/YYYY HH:MM:SS Example: 01/20/2020 10:11:01 Condition: Start Date is required if DecisionFlag is 1 and Rule Type is Promotional. |
EndDate datetime Conditional |
This is a conditional field where if required the user can provide a future date when the rule in context should end evaluating the loyalty. Valid Values: Format: MM/DD/YYYY HH:MM:SS Example: 01/20/2020 10:11:01 Condition: End Date is required if DecisionFlag is 1 and Rule Type is Promotional. |
NextAction integer Conditional |
Decide if system need to look for other loyalty rule or not. Valid Values: Stop - If the rule suffice the loyalty rule parameter and applied on the transaction then system will stop looking for other loyalty rule. Continue - If the rule suffice the loyalty rule parameter and applied on the transaction then also system look for other rule as well. Example: 2 Condition: Next Action is required if DecisionFlag is 1. |
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, "LoyaltyProgramID": 1, "DecisionFlag": 1, "RuleID": 1, "Priority": 1, "Status": 1, "StartDate": "09/10/2020 00:00:00", "EndDate": "10/10/2020 00:00:00", "NextAction": 1 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Added Successfully", "Status": true, "ErrorCode": "ERR01146", "ResponseData": null } }
GetLoyaltyRuleDetails
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyRuleDetails
This API is used to Get Details of Loyalty Rule via RuleID. Note: Rule ID can be Retreived using the 'SearchLoyaltyRuleDetails' API.
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 |
RuleID integer Mandatory |
ID of Loyalty Rule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234 |
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, "RuleID": 1 }
Response fields detail
Fields | Description |
---|---|
LoyaltyRule
|
LoyaltyRule |
DynamicQualificationLogicList array |
DynamicQualificationLogic list, will be populated only if Rule Type is Advance Promotional. |
IndividualQualificationSetupList array |
IndividualQualificationSetup list, will be populated only if Rule Type is Advance Promotional |
MerchantGroupList array |
MerchantGroup list Condition: This block is applicable only when Rule Setup On = [Merchant ID Group] OR [All/Multiple]. |
AcquiringInstitutionIdGroupList array |
AcquiringInstitutionIdGroup list Condition: This block is applicable only when Rule Setup On = [AcqInstIdGrp] OR [All/Multiple] |
MerchantCategoryList array |
MerchantCategoryList Condition: This block is applicable only when Rule Setup On = [Merchant Category] OR [All/Multiple]. |
MCCList array |
MCC List Condition: This block is applicable only when Rule Setup On = [MCC] OR [All/Multiple] |
SkuGroupList array |
SKU Group List Condition: This block is applicable only when Rule Setup On = [SKU] OR [All/Multiple] |
EntryModeList array |
EntryModeList Condition: This block is applicable only when Rule Setup On = [Entry Mode] OR [All/Multiple] |
ProductCodeList array |
Product Code List Condition: This block is applicable only when Rule Setup On = [Product Code] OR [All/Multiple] |
ProductCodeGroupList array |
Product Code Group List Condition: This block is applicable only when Rule Setup On = [Product Code Group] OR [All/Multiple] |
StateProvienceList array |
State/Province List Condition: This block is applicable only when Rule Setup On = [State/Province] OR [All/Multiple] |
CardPresentIndicatorList array |
CardPresentIndicatorList Condition: This block is applicable only when Rule Setup On = [Card Present/Not Present] OR [All/Multiple] |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyRule": { "RuleID": 79, "RuleName": "ruletest", "RuleType": 3, "RuleTypeDesc": "Advance Promotional", "RuleDescription": "test rule", "RuleDetailDescription": "test", "RuleApplication": 1, "RuleApplicationDesc": "Purchase", "RuleSetUpOn": 10, "RuleSetUpOnDesc": "All", "RuleStatus": 0, "RuleStatusDesc": "Active", "RuleCalculationMethod": 1, "CalculationBase": 2, "CalculationAmountPoints": 100.0, "CalculationPercent": null, "RoundingMethod": 0, "RoundingUnit": null, "MerchantGroupInEx": null, "MccCategoryInEx": null, "MccCodeInEx": null, "EntryModeInEx": null, "StateProvinceInEx": null, "ProductCodeGroupInEx": null, "ProductCodeInEx": null, "CardIndicatorInEx": null, "AcquiringInstitutionIdGroupInEx": null, "SkuGroupInEx": null, "PurchaseHistoryFound": 1, "XMonths": 6, "TotalSpendThresholdAmount": 10.0, "TotalPercentCap": 10.0, "ThresholdSpendCTD": 10.0, "MaxLoyaltyAmountEarningLimit": 10.0, "TransactionSizeThresholdAmount": 10.0, "TransactionCountThreshold": 10, "RewardNextToXTransactions": 10, "RewardApplicableFrom": 3, "RewardApplicableTo": 5, "ApplicableToXPeriod": 1, "TransactiontocheckforThreshold": 2, "MinimumCalculation": "1", "OneTimeReward": 1, "CalculatedRewardsOnOldTransactionsCount": 1, "CalculatedRewardsOnOldTransactionsSpend": 0, "NumberofConsecutiveGoodPayments": 1, "ChecktopSpending": 1, "RuleTypeInAlert": 3, "RuleReQualification": 1 }, "DynamicQualificationLogicList": null, "IndividualQualificationSetupList": [ { "ParameterName": "4 = MID Group", "OperatorConditon": "=", "AmountOrCount": null, "LogicalOperator": "AND", "AddtionalLogicalOperator": "AND", "MIDGroup": null, "MccCategory": null, "MCC": null, "PurchaseMethod": null } ], "MerchantGroupList": null, "AcquiringInstitutionIdGroupList": null, "MerchantCategoryList": null, "MCCList": null, "SkuGroupList": null, "EntryModeList": null, "ProductCodeList": null, "ProductCodeGroupList": null, "StateProvienceList": null, "CardPresentIndicatorList": null } } }
SearchLoyaltyRuleDetails
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/SearchLoyaltyRuleDetails
The Purpose of this API is fecth all the Loyalty Rules available for the 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 |
InstitutionID integer Mandatory |
Unique identification number for Institution. Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
RuleId integer Optional |
ID of Loyalty Rule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234 |
RuleType integer Optional |
Flag to decide the type of Loyalty Rule. Valid Values: 0: Base 1:Promotional 2:Advance Promotional 3:Exclusion Format:X Example:1 |
RuleStatus integer Optional |
Status of Loyalty Rule. Valid Values: 0: Active 1: Inactive Format: X Example: 1 |
RuleApplication integer Optional |
Type of transaction on which the Loyalty rule should trigger for the Account. Valid Values:Refer Appendix Section Format:X Example: Example:3 |
RuleSetupOn integer Optional |
Addtional criteria on which Loyalty rule should trigger for the Account. Valid Values:Refer Appendix Section Format:X Example:5 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "InstitutionID": 3241, "RuleId": null, "RuleType": null, "RuleStatus": null, "RuleApplication": null, "RuleSetupOn": null }
Response fields detail
Fields | Description |
---|---|
LoyaltyRulesList array |
Must return List of Loyalty Rules for the Institituion in an array, if a specifc parameter is selected in Input, then as per that Loyalty Rules must be returned as a list. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyRulesList": [ { "RuleID": 1, "RuleName": "Student Card Base Reward Rule", "RuleType": "Base", "RuleDescription": "1% Reward on All Purchases", "RuleApplication": null, "RuleApplicationDesc": "Purchase", "RuleSetUpOn": 0, "RuleSetUpOnDesc": null, "RuleStatus": 0, "RuleStatusDesc": null } ] } } }
GetSKUGroupDetails
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetSKUGroupDetails
The purpose of this API is to Get Existing External SKU Group Details.
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 |
GroupID integer Mandatory |
ID of the External SKU Group Valid Values: Numeric Format: XXXXXXXXX Example: 123 |
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, "GroupID": 1 }
Response fields detail
Fields | Description |
---|---|
GroupName string |
External SKU Group Name Valid Values: Name Format: XXXXXXXXXXX Example: XYZ Group Allowable Values: 50 |
SkuIDsMappingList array |
List of External SKU Groups for mentioned External SKUID. |
Sample response body
{ "application/json": { "Message": "Record Found", "Status": true, "ErrorCode": "ERR01520", "ResponseData": { "GroupName": "Test SKU Group", "SkuIDsMappingList": [ { "SKUID": "10", "Status": "ACTIVE" } ] } } }
GetLoyaltyRuleDetailsFromLoyaltyProgram
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetLoyaltyRuleDetailsFromLoyaltyProgram
This API is used to get the details of all the loyalty rule applicable on loyalty program.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: |