Category links

API Links

Get Account Charge-off Balances

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAccountChargeOffBalances

Use this API to retrieve all the charge-off balances, recovery fees, pending fees, late fees, annual fees etc. for a card account.

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/AdminNumber 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/AdminNumber 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 AccountNumber/AccountID/AdminNumber 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": "8000000000000029",
  "AccountID": 167494,
  "AdminNumber": 129363
}
Response fields details
Fields Description

BalanceCO

decimal

Balance on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

PrincipalATCO

decimal

Principal amount of loan at time of account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsufficientFeesATBNPCO

decimal

Pending fees on bill not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

LateFeesBNPATCO

decimal

Late fees on billing not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsuranceFeesBNPATCO

decimal

Insurance fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InterestBNPATCO

decimal

Interest on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

TransactionFeesBNPATCO

decimal

Transaction fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

AnnualFeesBNPATCO

decimal

Annual fees on bill not paid at charge off of account Valid Values: 0-9 Format: $XX.XX Example: $100.00

RecoveryFeesBNPATCO

decimal

Recovery fees on bill not paid at charge off on account Valid Values: 0-9 Format: $XX.XX Example: $100.00

OverlimitFeesBNPATCO

decimal

Overlimit fees on bill not paid on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CollectionFeesBNPATCO

decimal

Collection fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CashBalanceCO

decimal

Cash Balance on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "BalanceCO": 0.0,
    "PrincipalATCO": 0.0,
    "InsufficientFeesATBNPCO": 0.0,
    "LateFeesBNPATCO": 0.0,
    "InsuranceFeesBNPATCO": 0.0,
    "InterestBNPATCO": 0.0,
    "TransactionFeesBNPATCO": 0.0,
    "AnnualFeesBNPATCO": 0.0,
    "RecoveryFeesBNPATCO": 0.0,
    "OverlimitFeesBNPATCO": 0.0,
    "CollectionFeesBNPATCO": 0.0,
    "CashBalanceCO": 0.0
  }
}