GetCardholderSpendLimits
Action: POST
Endpoint: /api/GetCardholderSpendLimits
API Version 1.3
Request fields details
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 16 |
AccountNumber string Conditional |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
Sample request body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "", "AccountNumber": "", "ProxyNumber": "1314932" }
Response fields details
Fields | Description |
---|---|
Message string |
Returns Error Message in case of Error. |
Status boolean |
Returns result of API processing. If any error is found then value will be 'false' else 'true'. |
ErrorCode string |
Returns Error Code in case of Error. |
ResponseData
|
This is group of below data elements. |
ViewAccountSpendRuleResult
|
|
InternationalUseAllowed string |
International Use allowed or not. Valid values: 0 = Yes 1= No Example: 0 Allowable Values: 1 |
CashAccessAllowed string |
Cash access Transaction allowed or not. Valid values: 0 = No, 1= Yes Example: 1 Allowable Values: 1 |
PINPurchaseAllowed string |
Pin Transaction allowed or not. Valid values: 0 = No, 1= Yes Example: 1 Allowable Values: 1 |
OnlineTransactionsAllowed string |
Online Transactions allowed or not. Valid values: 0 = No, 1= Yes Example: 1 Allowable Values: 1 |
POSTransactionsAllowed string |
POS Transactions allowed or not. Valid values: 0 = No, 1= Yes Example: 1 Allowable Values: 1 |
BypassCardMonetaryLimit string |
Bypass limits set for the card Valid Values 0 = Yes 1 = No Example: 1 Allowable Values: 1 |
BypassCardMonetaryPeriod string |
Period for which limits will be bypassed. Valid Values: 0 = For next Transaction 1 = For next Day 2 = For One Month 3 = Forever Allowable Values: 1 |
BypassMerchantCategoryRestrictions string |
Bypass Merchant Category based restrictions set for the card Valid values: 0 = No, 1= Yes Example: 1 Allowable Values: 1 |
BypassMerchantCategoryPeriod string |
Period for which Merchant Category based restrictions will be bypassed. Valid Values: 0 = For next Transaction 1 = For next Day 2 = For One Month 3 = Forever Allowable Values: 1 |
CardSingleTransactionLimit decimal |
Single Transaction Limit Example: 120 |
CardDailySpendLimitCount Int32 |
Daily allowed transaction count Example: 5 |
CardDailySpendLimitAmount decimal |
Daily allowed transaction amount Example: 150 |
CardWeeklySpendLimitCount Int32 |
Weekly allowed transaction count Example: 5 |
CardWeeklySpendLimitAmount decimal |
Weekly allowed transaction amount Example: 150 |
CardMonthlySpendLimitCount Int32 |
Monthly allowed transaction count Example: 5 |
CardMonthlySpendLimitAmount decimal |
Monthly allowed transaction amount Example: 150 |
CardNotPresentCardSingleTransactionLimit decimal |
Single Transaction Limit for card not present transaction Example: 120 |
CardNotPresentCardDailySpendLimitCount Int32 |
Daily allowed transaction count for card not present transaction Example: 5 |
CardNotPresentCardDailySpendLimitAmount decimal |
Daily allowed transaction amount for card not present transaction Example: 150 |
CardNotPresentCardWeeklySpendLimitCount Int32 |
Weekly allowed transaction count for card not present transaction Example: 5 |
CardNotPresentCardWeeklySpendLimitAmount decimal |
Weekly allowed transaction amount for card not present transaction Example: 150 |
CardNotPresentCardMonthlySpendLimitCount Int32 |
Monthly allowed transaction count for card not present transaction Example: 5 |
CardNotPresentCardMonthlySpendLimitAmount decimal |
Monthly allowed transaction amount for card not present transaction Example: 150 |
PINPOSCardSingleTransactionLimit decimal |
Single Transaction Limit for Pin POS transaction Example: 120 |
PINPOSCardDailySpendLimitCount Int32 |
Daily allowed transaction count for Pin POS transaction Example: 5 |
PINPOSCardDailySpendLimitAmount decimal |
Daily allowed transaction amount for Pin POS transaction Example: 150 |
PINPOSCardWeeklySpendLimitCount Int32 |
Weekly allowed transaction count for Pin POS transaction Example: 5 |
PINPOSCardWeeklySpendLimitAmount decimal |
Weekly allowed transaction amount for Pin POS transaction Example: 150 |
PINPOSCardMonthlySpendLimitCount Int32 |
Monthly allowed transaction count for Pin POS transaction Example: 5 |
PINPOSCardMonthlySpendLimitAmount decimal |
Monthly allowed transaction amount for Pin POS transaction Example: 150 |
SignaturePOSCardSingleTransactionLimit decimal |
Single Transaction Limit for Signature POS transaction Example: 120 |
SignaturePOSCardDailySpendLimitCount Int32 |
Daily allowed transaction count for Signature POS transaction Example: 5 |
SignaturePOSCardDailySpendLimitAmount decimal |
Daily allowed transaction amount for Signature POS transaction Example: 150 |
SignaturePOSCardWeeklySpendLimitCount Int32 |
Weekly allowed transaction count for Signature POS transaction Example: 5 |
SignaturePOSCardWeeklySpendLimitAmount decimal |
Weekly allowed transaction amount for Signature POS transaction Example: 150 |
SignaturePOSCardMonthlySpendLimitCount Int32 |
Monthly allowed transaction count for Signature POS transaction Example: 5 |
SignaturePOSCardMonthlySpendLimitAmount decimal |
Monthly allowed transaction amount for Signature POS transaction Example: 150 |
ContactlessCardSingleTransactionLimit decimal |
Single Transaction Limit for contactless transaction Example: 120 |
ContactlessCardDailySpendLimitCount Int32 |
Daily allowed transaction count for contactless transaction Example: 5 |
ContactlessCardDailySpendLimitAmount decimal |
Daily allowed transaction amount for contactless transaction Example: 150 |
ContactlessCardWeeklySpendLimitCount Int32 |
Weekly allowed transaction count for contactless transaction Example: 5 |
ContactlessCardWeeklySpendLimitAmount decimal |
Weekly allowed transaction amount for contactless transaction Example: 150 |
ContactlessCardMonthlySpendLimitCount Int32 |
Monthly allowed transaction count for contactless transaction Example: 5 |
ContactlessCardMonthlySpendLimitAmount decimal |
Monthly allowed transaction amount for contactless transaction Example: 150 |
RecurringTransactionAllowed string |
Recurring Transactions allowed or not. Valid values: 0 = No, 1 = Yes Example: 1 Allowable Values: 1 |
MerchantCategory array |
MerchantCategory |
MerchantCategoryCodePlan string |
Merchant Category Code Plan Valid values:0-9 Example: 5,6 Allowable Values: 5 |
MerchantCategoryCodePlanSelection string |
Merchant Category Code plan value Valid values: 0 = MCC Limits will not be considered 1 = MCC Limits will be considered Allowable Values: 1 |
MCCDailyPlanLimitCount Int32 |
MCC Daily allowed transaction count Example : 5 |
MCCDailyPlanLimitAmount decimal |
MCC Daily allowed transaction amount Valid Values: 0-9 Example: 120 |
MCCMonthlyPlanLimitCount Int32 |
MCC Monthly allowed transaction count Valid Values: 0-9 Example: 5 |
MCCMonthlyPlanLimitAmount decimal |
MCC Monthly allowed transaction amount Valid Values: 0-9 Example: 120 |
MCCWeeklyPlanLimitCount Int32 |
MCC Weekly allowed transaction count Valid Values: 0-9 Example: 5 |
MCCWeeklyPlanLimitAmount decimal |
MCC Weekly allowed transaction amount Valid Values: 0-9 Example: 120 |
MCCDescription string |
Merchant Category Code Plan Example: 5 = Fuel 6 = Ground Travel Allowable Values: 20 |
MCCPlanDescription string |
Merchant Types which belongs to Merchant Category Code Plan Example: MCC Description = 'Meals' will contain Caterers, eating, drinking places, fast food restaurants, convenience stores Allowable Values: 20 |
ContactlessTransactionAllowed string |
Contactless Transaction allowed or not. Valid values: 0 = No, 1 = Yes Example: 1 Allowable Values: 1 |
CardNotPresentTransactionAllowed string |
Card not present Transaction allowed or not. Valid values: 0 = No, 1 = Yes Example: 1 Allowable Values: 1 |
PurchasewithCashbackAllowed string |
Purchase with Cashback Allowed. Valid values: 0 = No, 1 = Yes Example: 1 Allowable Values: 1 |
Sample response body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "ViewAccountSpendRuleResult": { "InternationalUseAllowed": "0", "CashAccessAllowed": "1", "PINPurchaseAllowed": "", "OnlineTransactionsAllowed": "1", "POSTransactionsAllowed": "1", "BypassCardMonetaryLimit": "1", "BypassCardMonetaryPeriod": "", "BypassMerchantCategoryRestrictions": "1", "BypassMerchantCategoryPeriod": "", "CardSingleTransactionLimit": 5500.0, "CardDailySpendLimitCount": 100, "CardDailySpendLimitAmount": 5500.0, "CardWeeklySpendLimitCount": 120, "CardWeeklySpendLimitAmount": 5600.0, "CardMonthlySpendLimitCount": 130, "CardMonthlySpendLimitAmount": 5700.0, "CardNotPresentCardSingleTransactionLimit": 5500.0, "CardNotPresentCardDailySpendLimitCount": 10, "CardNotPresentCardDailySpendLimitAmount": 5500.0, "CardNotPresentCardWeeklySpendLimitCount": 12, "CardNotPresentCardWeeklySpendLimitAmount": 5500.0, "CardNotPresentCardMonthlySpendLimitCount": 11, "CardNotPresentCardMonthlySpendLimitAmount": 5600.0, "PINPOSCardSingleTransactionLimit": 100.0, "PINPOSCardDailySpendLimitCount": 1, "PINPOSCardDailySpendLimitAmount": 200.0, "PINPOSCardWeeklySpendLimitCount": 2, "PINPOSCardWeeklySpendLimitAmount": 400.0, "PINPOSCardMonthlySpendLimitCount": 5, "PINPOSCardMonthlySpendLimitAmount": 500.0, "SignaturePOSCardSingleTransactionLimit": 200.0, "SignaturePOSCardDailySpendLimitCount": 11, "SignaturePOSCardDailySpendLimitAmount": 200.0, "SignaturePOSCardWeeklySpendLimitCount": 12, "SignaturePOSCardWeeklySpendLimitAmount": 250.0, "SignaturePOSCardMonthlySpendLimitCount": 13, "SignaturePOSCardMonthlySpendLimitAmount": 350.0, "ContactlessCardSingleTransactionLimit": 200.0, "ContactlessCardDailySpendLimitCount": 11, "ContactlessCardDailySpendLimitAmount": 200.0, "ContactlessCardWeeklySpendLimitCount": 12, "ContactlessCardWeeklySpendLimitAmount": 250.0, "ContactlessCardMonthlySpendLimitCount": 13, "ContactlessCardMonthlySpendLimitAmount": 350.0, "RecurringTransactionAllowed": "0", "MerchantCategory": [ { "MerchantCategoryCodePlan": "44", "MerchantCategoryCodePlanSelection": "0", "MCCDailyPlanLimitCount": 1, "MCCDailyPlanLimitAmount": 100.0, "MCCMonthlyPlanLimitCount": 2, "MCCMonthlyPlanLimitAmount": 200.0, "MCCWeeklyPlanLimitCount": 3, "MCCWeeklyPlanLimitAmount": 300.0, "MCCDescription": "Eating Places And Restaurants", "MCCPlanDescription": "Eating Places And Restaurants" } ], "ContactlessTransactionAllowed": "0", "CardNotPresentTransactionAllowed": "0", "PurchasewithCashbackAllowed": "1" } } }