GetBilledNotPaid
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetBilledNotPaid
Populates field value which contributes to Balance subject Finance Charge.
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/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one of AccountNumber or 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). Valid values:0-9 Example:12345 Condition: At least one of AccountNumber or 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, "AccountNumber": "8110000000000109", "AccountID": null }
Response fields details
Fields | Description |
---|---|
TransactionFeesBNP decimal |
Indicates transaction fee subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
AnnualFeesBNP decimal |
Indicates Annual fee subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
LateFeesBNP decimal |
Indicates Late fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InterestBNP decimal |
Indicates interest subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
RecoveryFeesBNP decimal |
Indicates Recovery fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InsufficientFundsFeesBNP decimal |
Indicates fee subject to finance charge due to insufficient funds in account, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
CollectionFeesBNP decimal |
Indicates Collection fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InsuranceFeeBNP decimal |
Indicates Insurance fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
OverlimitFeesBNP decimal |
Indicates Overlimit fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
TxnFeesPendingBNP decimal |
Indicates pending transaction fee which is subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
MembershipFeePendingBNP decimal |
Indicates pending Annual fee subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
LateFeesPendingBNP decimal |
Indicates pending Late fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InterestPendingBNP decimal |
Indicates pending interest subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
RecoveryFeesPendingBNP decimal |
Indicates pending Recovery fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InsufficientFundsFeesPendingBNP decimal |
Indicates pending fee subject to finance charge due to insufficient funds in account, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
CollectionFeesPendingBNP decimal |
Indicates pending Collection fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
InsurancePendingBNP decimal |
Indicates pending Insurance fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
OverlimitFeesPendingBNP decimal |
Indicates pending Overlimit fees subject to finance charge, depending on interest setup Valid Values:0-9 Format:XXX.00 Example: 300.00 |
Principal decimal |
Principal amount of loan on the account Valid Values:0-9 Format:XXX.00 Example: 300.00 |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "TransactionFeesBNP": 0.0, "AnnualFeesBNP": 0.0, "LateFeesBNP": 0.0, "InterestBNP": 0.0, "RecoveryFeesBNP": 0.0, "InsufficientFundsFeesBNP": 0.0, "CollectionFeesBNP": 0.0, "InsuranceFeeBNP": 0.0, "OverlimitFeesBNP": 0.0, "TxnFeesPendingBNP": 0.0, "MembershipFeePendingBNP": 0.0, "LateFeesPendingBNP": 0.0, "InterestPendingBNP": 0.0, "RecoveryFeesPendingBNP": 0.0, "InsufficientFundsFeesPendingBNP": 0.0, "CollectionFeesPendingBNP": 0.0, "InsurancePendingBNP": 0.0, "OverlimitFeesPendingBNP": 0.0, "Principal": 1500.48 } }