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 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 |
|
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 details
| Fields | Description |
|---|---|
|
StatusDefinition
|
The list of parameters configured for mentioned status. |
Sample response body
{
"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,
"InitiateChargeOffAtZeroBalance": null,
"CardStatusAction": null,
"PartnerStatusCateogry": null,
"PromoPlan": null,
"PromoPlanTurnOffMsg": null,
"AlertSuppress": null,
"SendToFraud": null,
"AllowDebitWriteOff": null,
"AllowCashTransaction": null,
"StatusDueToOptingOutOfPenaltyPricing": null,
"IssuerFileUpdateProfile": null,
"NYMandateRewardRedemption": null,
"StatusGroup": 0,
"ExcludeFromCBR": null,
"CBRSpecialComment": null,
"ComplianceConditionCode": null,
"ConsiderasClosed": "0",
"SendToCollections": 0,
"SetDunSuppress": 1,
"RestructureActionCode": null,
"CloseCaseActionCode": null,
"OverridePriority": null,
"GenerateEmail": null,
"GenerateSMS": null,
"GenerateLetter": null,
"AllowCustomerServiceReage": null,
"AccountActivationAllowed": null,
"AllowChangeInBillingCycle": null,
"UpdateSameStatusForLinkedCustomerAccount": null
}
}
}