Account Balances
You can use the CoreCard API to get details of account balances. You can also get the details of the balance which is a result of the transfer, total fee details, total outstanding amount, and various fees balances that have been charged over the period on account, cash advances balances, debit balances & credit balances, etc. (refer GetAccountBalances API).
GetCardBalanceDetails
Action: POST
Endpoint: /api/GetCardBalanceDetails
Use this API to get the Balance details of Account which includes details like Available balance, current balance , Pending Auths, Last and next statement date, Derived and Card manual status.
Request Fields Detail
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 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition : At least one of Card Number/Proxy Number is required. 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 is required. Allowable Values: 16 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "ProxyNumber": "1316728", "CardNumber": "" }
Response Fields Detail
Fields | Description |
---|---|
CardNumber string |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Allowable Values: 16 |
AccountNumber string |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Allowable Values: 19 |
AvailableBalance decimal |
Available balance on the account Valid values : 0-9 E.g.: 100.50 |
CurrentBalance decimal |
This tag indicates the current balance of the account |
LastCreditAmount decimal |
Last Credited Amount in the card Valid Values: 0-9 Format: XXX.XX Example: 150.00 |
NextStatementDate datetime |
Next Statement Date Format: YYYY-MM-DDTHH:MM:SS Example: 2021-05-01T00:00:00 |
LastStatementDate datetime |
Last Statement Date Format: YYYY-MM-DDTHH:MM:SS Example: 2021-04-01T00:00:00 |
CurrentCardPendingAuths string |
It shows pending auth transaction on current Card. Example: 100.00 Allowable Values: 8 |
CustomAccountID string |
Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Allowable Values: 25 |
DerivedStatusDescription string |
Status which is derived by considering Card Status (manual and generated), account status (manual and generated) and Card plastic status Example: Active Allowable Values: 100 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CardNumber": "406685******0935", "AccountNumber": "60000000032471", "AvailableBalance": 12.0, "CurrentBalance": 12.0, "LastCreditAmount": 12.0, "NextStatementDate": "2020-12-22T00:00:00", "LastStatementDate": "2017-02-12T00:00:00", "CurrentCardPendingAuths": "0.01", "CustomAccountID": "", "DerivedStatusDescription": "Active" } }