Get Account Details
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetAccountDetails
Use this API to retrieve general account information, such as the following:
1. Institution to which the card account belongs, like institution ID, product ID, merchant ID, and store name
2. Basic account details, like account holder data, primary currency code, and account status
3. Account control attributes, like credit limit, over-limit credit, billing cycle, regulation flag, and cash credit limit
4. Account balance and transactional details, like principal, cash open to buy, last debit amount, total outstanding amount, fee details, due amounts, statement balance, and available balance
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 |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AccountID is required. Allowable Values: 19 |
|
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 AccountNumber/AccountID is required. |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format: XXXXX Example:12345 Condition:At least one of AdminNumber/AccountNumber/AccountID is required. |
|
IdentifierToken string Conditional |
A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required. Allowable Values: 800 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.0",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"AccountNumber": "5000000000014059",
"AccountID": 161563,
"AdminNumber": null,
"IdentifierToken": null
}
Response fields details
| Fields | Description |
|---|---|
|
AccountDetails
|
AccountDetails |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"AccountDetails": {
"AccountID": 0,
"CycleSpendLimit": 0.0,
"RemainingCycleSpendLimit": 0.0,
"SystemStatus": 2,
"AccountNumber": "5000000000014059",
"ProductID": 0,
"ProductName": "abc V1.0",
"ClientID": 7031,
"ClientName": "abc",
"PrimaryCurrencyCode": "US Dollar",
"CurrentBalance": 19.99,
"ManualAccountStatus": "Active",
"StoreID": 0,
"StoreName": "abcd",
"DisputesAmountNS": 0.0,
"AvailableBalance": 0.0,
"TotalAmountDue": 0.0,
"PendingOTB": 0.0,
"PaymentDueDate": null,
"LastPurchaseAmount": 19.99,
"BeginningBalance": 138.65,
"LastPaymentAmount": 206.69,
"Principal": 19.99,
"DaysInCycle": 17,
"OverlimitCredit": 0.0,
"TotalDue": 0.0,
"CreditLimit": 6000.0,
"MinimumCreditLine": 100.0,
"AccountState": "NORMAL",
"BillingCycle": "30",
"DateOfApplication": "12/31/2016 00:00:00",
"DateAccountOpened": null,
"DateAccountClosed": null,
"DateOfFirstOrder": "12/31/2016 00:00:00",
"CurrentDue": 0.0,
"PastDue": 0.0,
"TotalPastDue": 0.0,
"OriginalCreditLimit": 0.0,
"TotalOutStandingAmount": 0.0,
"CashOutStandingAmount": 0.0,
"PurchaseOutStandingAmount": 0.0,
"ReturnOutStandingAmount": 0.0,
"ApplicationNumber": 9105381735,
"HighBalance": 345.34,
"BalanceCO": 0.0,
"CashBalanceCO": 0.0,
"PrincipalATCO": 0.0,
"InsufficientFeesATBNPCO": 0.0,
"LateFeesBNPATCO": 0.0,
"InsuranceFeesBNPATCO": 0.0,
"CollectionFeesBNPATCO": 0.0,
"InterestBNPATCO": 0.0,
"TransactionFeesBNPATCO": 0.0,
"AnnualFeesBNPATCO": 0.0,
"RecoveryFeesBNPATCO": 0.0,
"OverlimitFeesBNPATCO": 0.0,
"CompanyName": null,
"CompanyNumber": null,
"CorporateAccountNumber": null,
"LastCreditAmount": 206.69,
"AccountCategory": null,
"LastDebitAmount": 19.99,
"LastStatementDate": "12/31/2016 00:00:00",
"NextStatementDate": "12/31/2016 00:00:00",
"AccountType": "Cardholder",
"CashCreditLimit": null,
"PendingBillingCycle": null,
"CashBalance": 0.0,
"CashOpenToBuy": 0.0,
"StatementProduction": "Process normally",
"PartnerID": null,
"SCRAEffectiveDate": null,
"SCRAEndDate": null,
"PromoPurchaseAllowed": null,
"StatementRunningBalance": null,
"StatementRemainingBalance": null,
"TestAccount": "NO",
"RequestedLoanAmount": 0.0,
"MinimumRunningDue": null,
"MinimumRemainingDue": null,
"UniversalUniqueID": null,
"BillingTableName": "abc_001",
"DebitWriteOffDate": null,
"CreditWriteOnDate": null,
"ExceededPastDueDaysPermitted": "NO",
"RegulationOFlag": false,
"RegulationOFlagEffectiveDate": null,
"AutoPayIndicator": "NO",
"CoOwnerExists": null,
"HoldDaysApplicableonAccount": 0,
"BypassExistingPaymentHoldLogic": null,
"OptOutofPenaltyPricing": "Yes",
"AssociationProductType": null,
"RewardID": null,
"GracePaymentDueDate": null,
"MinimumPaymentDue": null,
"LastStatementBalance": null,
"DaysDelinquent": null
}
}
}