Get Plan Details
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetPlanDetails
Use this API to obtain the list of applicable plan segments and details of their attributes by using an account ID. The API returns details such as the credit plan, principal amount, interest plan, and current or past due date for each planning segment.
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 |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one of AdminNumber/AccountNumber/AccountID is required. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber/AccountID is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber/AccountID is required. |
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, "AccountID": 167414, "AccountNumber": null, "AdminNumber": null }
Response fields details
Fields | Description |
---|---|
PlanSegments array |
PlanSegments |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "PlanSegments": [ { "PlanName": "ABC Invoice_USA", "AccountID": 101241, "CreditPlanMaster": "5570", "CreditPlanMasterName": "ABC Invoice_USA", "CreditPlanType": "Purchase", "PlanSegmentCreationDate": "01/15/2017 00:00:00", "CurrentBalance": 0.0, "TotalDue": 0.0, "CyclesDue": "Nothing Due", "InvoiceNumber": "0016741400000001", "OpenToBuy": 0.0, "EqualPaymentAmount": 0.0, "CashBalance": 0.0, "PrepaymentAmount": 0.0, "PrePaymentCounter": 0.0, "BeginningBalance": 0.0, "Principal": 0.0, "BilledPrincipal": 0.0, "HighBalance": 0.0, "MultiplePlanAllowed": null, "FixedPaymentAmount": 0.0, "MultipleSalesAllowed": "Create new plan segment for each invoice period", "FixedPaymentPercentage": 1.0, "PaymentType": "Bill Invoice", "EqualPayments": null, "AnnuityPaymentMethod": null, "InterestPlan": "ABC001_USA", "InternalRateOfReturn": 0.0, "NewTransactionBSFC": 0.0, "RevolvingTransactionBSFC": 0.0, "NewTransactionAccruedInterest": 0.0, "RevolvingTransactionAccruedInterest": 0.0, "NewTransactionAggregate": 0.0, "RevolvingTransactionAggregate": 0.0, "TotalAccruedInterest": 0.0, "AfterCycleRevolvingBSFC": 0.0, "AccrueInterestonChargedOffAccounts": "Do not accrue interest", "AnticipatedAccruedInterest": 0.0, "InterestStartDate": null, "InterestDisposition": null, "PaymentDefermentStatus": null, "PayOffDate": null, "DeferredAggregate": 0.0, "DeferredAccruedInterest": 0.0, "InterestDefermentStatus": null, "PaymentStartDate": null, "DefermentRollOverDate": null, "CancellationNotificationDate": null, "DeferredAggregateDays": 0, "DeferredAccruedFinalInterest": 0.0, "InterestBNP": 0.0, "LateFeesBNP": 0.0, "MembershipFeePendingBNP": 0.0, "InsufficientFundFeeBNP": 0.0, "OverlimitFeesBNP": 0.0, "CollectionFeesBNP": 0.0, "RecoveryFeesBNP": 0.0, "InsuranceFeeBNP": 0.0, "InterestPendingBNP": 0.0, "LateFeesPendingBNP": 0.0, "InsufficientFundFeePendingBNP": 0.0, "OverlimitFeesPendingBNP": 0.0, "RecoveryFeesPendingBNP": 0.0, "InsuranceFeesPendingBNP": 0.0, "ChargeOffBalance": 0.0, "ChargeOffPrincipal": 0.0, "ChargeOffTransactionFeesBNP": 0.0, "ChargeOffAnnuaFeesBNP": 0.0, "ChargeOffLateFeesBNP": 0.0, "ChargeOffOverlimitFeesBNP": 0.0, "ChargeOffInsufficientFundsFeesBNP": 0.0, "ChargeOffCollectionFeesBNP": 0.0, "ChargeOffInterestBilledBNP": 0.0, "ChargeOffInsuranceBilledBNP": 0.0, "ChargeOffRecoveryFeesBNP": 0.0, "PortfolioID": null, "InterestRate1": 0.0, "InterestRate2": 0.0, "InterestRate3": 0.0, "InterestRate4": 0.0, "PromoStartDate": null, "PromoEndDate": null, "PromoTransactionStartDate": null, "PromoTransactionEndDate": null, "PromoPlanStatus": 0, "PromoRateDuration": 0 } ] } }