Manual Charge-off
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/ManualChargeOff
Use this API to manually charge-off a card account when the possibility of due recovery is nil or minimal. A user may set the account's charge off status, such as "started initial charge-off" or "started final charge-off", by selecting an appropriate reason, such as Bankruptcy or Fraud. A user can also provide the start date and timing for a manual initial charge-off. Additionally, a user may provide values, such as one cycle past due or two cycles past due, when setting the timing for auto initial charge-offs.
Request fields details
| Fields | Description |
|---|---|
|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 ---- es: means Spanish Allowable Values: 10 |
|
ExternalIP string |
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 |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
|
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 the account to be charged off. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Admin number of the account to be charged off. Valid Values: 0-9 Example: 12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID |
|
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 Format:XXXXX Example:12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID |
|
UserChargeOffStatus integer Optional |
Status that user wants to set for mentioned account. Valid Values: 0-4 0 - Not Charged-off 1 - Pending Manual Initial Charge-off 2 - Hold Initial Charge-off 3 - Started Initial Charge-off 4 - Started Final Charge-off Format: X Example: 1 Condition: Either 1 of UserChargeOffStatus Or AutoInitialChargeOff is required. |
|
InitialManualChargeOffReason integer Conditional |
Reason to initiate manual charge-off Valid Values: 0-7 0 - None 1 - Credit Losses 2 - Bankruptcy 3 - Fraud 4 - Other 6 - Deceased 7 - Contractional Format: X Example: 3 Condition: Mandatory if UserChargeOffStatus has a valid value |
|
FinalStatement integer Optional |
If final statement is needed or not Valid Values: 0, 1 0 - No 1 - Yes Format: X Example: 1 Condition: Default 1 |
|
ManualInitialChargeOffStartDate datetime Optional |
Start Date of Manual Initial Charge-Off Format: MM/DD/YYYY Example: 05/01/2020 |
|
TimingOption integer Optional |
Option to initiate charge-off Valid Values: 0, 1, 2 0 - Default 1 - Charge-off Date 2 - Last Payment Date Format: X Example: 0 Condition: Pass value 0 by default |
|
AutoInitialChargeOff integer Optional |
Value of delinquency to be overriden wrt configured value. Valid Values: 0, 3, 4, 5, 6, 7, 8 0 - None 3 - 1 Cycle Past Due 4 - 2 Cycle Past Due 5 - 3 Cycle Past Due 6 - 4 Cycle Past Due 7 - 5 Cycle Past Due 8 - 6 Cycle Past Due Format: X Example: 3 |
|
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 the account to be charged off. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Admin number of the account to be charged off. Valid Values: 0-9 Example: 12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID |
|
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 Format:XXXXX Example:12345 Condition: At least one account identifier is required from: 1. AccountNumber 2. AdminNumber 3. AccountID |
|
UserChargeOffStatus integer Conditional |
Status that user wants to set for mentioned account. Valid Values: 0-4 0 - Not Charged-off 1 - Pending Manual Initial Charge-off 2 - Hold Initial Charge-off 3 - Started Initial Charge-off 4 - Started Final Charge-off Format: X Example: 1 Condition: Either 1 of UserChargeOffStatus Or AutoInitialChargeOff is required. |
|
InitialManualChargeOffReason integer Conditional |
Reason to initiate manual charge-off Valid Values: 0-7 0 - None 1 - Credit Losses 2 - Bankruptcy 3 - Fraud 4 - Other 6 - Deceased 7 - Contractional Format: X Example: 3 Condition: Mandatory if UserChargeOffStatus has value = 1 |
|
FinalStatement integer Optional |
If final statement is needed or not Valid Values: 0, 1 0 - No 1 - Yes Format: X Example: 1 Condition: Default 1 |
|
ManualInitialChargeOffStartDate datetime Optional |
Start Date of Manual Initial Charge-Off Format: MM/DD/YYYY Example: 05/01/2020 |
|
TimingOption integer Optional |
Option to initiate charge-off Valid Values: 0, 1, 2 0 - Default 1 - Charge-off Date 2 - Last Payment Date Format: X Example: 0 Condition: Pass value 0 by default |
|
AutoInitialChargeOff integer Conditional |
Value of delinquency to be overriden wrt configured value. Valid Values: 0, 3, 4, 5, 6, 7, 8 0 - None 3 - 1 Cycle Past Due 4 - 2 Cycle Past Due 5 - 3 Cycle Past Due 6 - 4 Cycle Past Due 7 - 5 Cycle Past Due 8 - 6 Cycle Past Due Format: X Example: 3 Condition:Either 1 of UserChargeOffStatus Or AutoInitialChargeOff 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": "1000000700000093",
"AdminNumber": null,
"AccountID": null,
"UserChargeOffStatus": 1,
"InitialManualChargeOffReason": 2,
"FinalStatement": 1,
"ManualInitialChargeOffStartDate": null,
"TimingOption": 0,
"AutoInitialChargeOff": null
}
Response fields details
| Fields | Description |
|---|
Sample response body
{
"Message": "Successfully applied manual charge off",
"Status": true,
"ErrorCode": "ERR01052",
"ResponseData": null
}