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 details
| Fields | Description |
|---|---|
|
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 |
|
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
}
Response fields details
| Fields | Description |
|---|---|
|
ServiceChargeDetails
|
serviceChargeDetails |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ServiceChargeDetails": {
"ServiceChargePlanName": 613,
"PrimaryCurrencyCode": "US Dollar",
"ServiceChargePlanParentName": "Template Record",
"MonetaryTransactionControlGroup": 78,
"DefaultCreditPlanName": "abcd",
"TransactionFeesDefaultCreditPlanName": "Use Default Credit Plan Name",
"GSTFeeGroup": "SGST",
"MerchantId": 11607,
"DefaultRecoveryFeeCreditPlanName": "abcd",
"ChargePenaltyFeeOnNegativeRewardBalance": null,
"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,
"ReturnAnnualFeeOnCardCancellation": null,
"AnnualFeeRefundDays": null,
"TransactionFeesList": null,
"AuthorizationFeesList": null,
"CardFeesList": null,
"ActiveFeesList": null,
"ServiceFeesList": null,
"ManualFeesList": null,
"MessageFeesList": null,
"FeeGroupList": [
{
"FeeGroupName": null,
"FeeGroupPriority": "1",
"MaxNumberOfFeesPerDay": "1",
"MaxNumberOfFeesPerMonth": null,
"MaxNumberOfFeesPerCycle": "1",
"MaxNumberOfFeesPerYear": "12",
"MaxFeesCycleToDate": 9999.0,
"AccountToBeInactiveForMinimum": null,
"FeeGroupPeriod": null
}
]
}
}
}