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 details
| 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 Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
|
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
|
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
|
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
|
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
|
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
|
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
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 details
| 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
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"AccountControlDetails": {
"MerchantID": 11607,
"AccountControlTableName": 6859,
"PrimaryCurrencyCode": "US Dollar",
"AccountControlTableParent": 1,
"MonetaryTransactionControlGroup": 78,
"PurchasePlanMaster": 6153,
"CashPlanMaster": null,
"DefaultBalanceTransferPlan": null,
"OverlimitBalance": 1000,
"CashLimitMethod": 0,
"CashLimitAmount": 10000.0,
"CashLimitPercentage": 0.0,
"GeneralFeeDisclosureMethod": 1,
"GeneralFeeDisclosureCycles": 2,
"AccountBillingTypeMethod": 1,
"MerchantCategoryCodeGroupName": 1024,
"PenaltyPriceLevel": "Account",
"PenaltyPricingApplyAmount": "Current Balance",
"AccountStatusforPenaltyPricing": "9974",
"PenaltyPricingOptOutAccountStatus": "10557",
"PenaltyInterestTableOccurrence": null,
"NumberOfDaysBeforePenaltyPricingApplied": null,
"AdvancedPenaltyPricingMethodLogicName": null,
"DynamicRuleGroupArrayForMethod": null,
"AdvancedPenaltyPricingCureLogicName": null,
"DynamicRuleGroupArrayForCure": null,
"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,
"AccruedInterestWaiverLimit": null,
"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,
"ContractualDelinquency2Level": null,
"ContractualDelinquency2Status": null,
"ContractualDelinquency2CureStatus": null,
"LateDelinquency2Level": null,
"LateDelinquency2Status": null,
"LateDelinquency2CureStatus": null,
"Delinquency3CureAction": null,
"Delinquency3Timing": null,
"ContractualDelinquency3Level": null,
"ContractualDelinquency3Status": null,
"ContractualDelinquency3CureStatus": null,
"LateDelinquency3Level": null,
"LateDelinquency3Status": null,
"LateDelinquency3CureStatus": null,
"Delinquency4CureAction": null,
"Delinquency4Timing": null,
"ContractualDelinquency4Level": null,
"ContractualDelinquency4Status": null,
"ContractualDelinquency4CureStatus": null,
"LateDelinquency4Level": null,
"LateDelinquency4Status": null,
"LateDelinquency4CureStatus": null
}
}
}