Core Card Api Quick Start

Manual Reage Adjusted

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/ManualReageAdjusted

Use this API to manually re-age the account. Manual re-aging is used to reduce the delinquency level of an account. For example, if an account is 5 cycle past due (5 CPD), a user could do a manual re-age, either in full or in part, to reduce the account's delinquency level .

The API enables a user to choose between a full amount or partial amount re-age. If a user chooses to partially re-age the account, further methods for partial re-aging (i.e., re-aging using the total due method, whereby the due amount is reduced with the amount as inserted in API) or re-age using the cycle due method (i.e., reducing the cycle dues on the account), additional information must be provided.

Note

Manual re-age can only be adjusted if the account qualifies for re-age criteria.

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
TypeOfManualReage integer Optional	Indicates if Reage is Full or Partial Valid Values: 0 - Full / 1 - Partial Format: Numeric Example: 0
TotalDueMethod decimal Conditional	Indicates total amount due adjusted as reage Valid Values: 0-9 Format: Numeric Example: $150.00 Condition: Either TotalDueMethod or CycleDueMethod must be provided // Fixed TD 240579
CycleDueMethod string Conditional	Indicates if method used to reage is Cycle Due Method and what is the delinquency level used to reage account 0 - Nothing Due 1 - Current Due 10 - No Payments 2 - Past Due 3 - 1 Cycle Past Due 4 - 2 Cycles Past Due 5 - 3 Cycles Past Due 6 - 4 Cycles Past Due 7 - 5 Cycles Past Due 8 - 6 Cycles Past Due 9 - 7 Cycles Past Due Valid Values: 0-10 Format: X Example: 0 Condition: Either TotalDueMethod or CycleDueMethod must be provided. Allowable Values: 25
CurrentCycleDue string Conditional	Amount currently due on account Valid Values: 0-9 Format: $XX.XX Example: $100.00 Allowable Values: 25
AccountNumber string Conditional	Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier 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 CardNumber/AdminNumber/AccountNumber/AccountID is required.
TotalDue decimal Optional	Total Amount Due as on account Valid Values: 0-9 Format: $XX.XX Example: $150.99
MrSevenCyclesPastDue decimal Optional	Amount Seven Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrSixCyclesPastDue decimal Optional	Amount Six Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrFiveCyclesPastDue decimal Optional	Amount Five Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrFourCyclesPastDue decimal Optional	Amount Four Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrThreeCyclesPastDue decimal Optional	Amount Three Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrTwoCyclesPastDue decimal Optional	Amount Two Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrOneCyclesPastDue decimal Optional	Amount One Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrPastDue decimal Optional	Amount past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrCurrentDue decimal Optional	Amount current due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50
MrTotalPastDue decimal Optional	Total amount past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

Fields

Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

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:

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:

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:

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TypeOfManualReage

integer

Optional

Indicates if Reage is Full or Partial Valid Values: 0 - Full / 1 - Partial Format: Numeric Example: 0

TotalDueMethod

decimal

Conditional

Indicates total amount due adjusted as reage Valid Values: 0-9 Format: Numeric Example: $150.00 Condition: Either TotalDueMethod or CycleDueMethod must be provided // Fixed TD 240579

CycleDueMethod

string

Conditional

Indicates if method used to reage is Cycle Due Method and what is the delinquency level used to reage account 0 - Nothing Due 1 - Current Due 10 - No Payments 2 - Past Due 3 - 1 Cycle Past Due 4 - 2 Cycles Past Due 5 - 3 Cycles Past Due 6 - 4 Cycles Past Due 7 - 5 Cycles Past Due 8 - 6 Cycles Past Due 9 - 7 Cycles Past Due Valid Values: 0-10 Format: X Example: 0 Condition: Either TotalDueMethod or CycleDueMethod must be provided.

Allowable Values:

CurrentCycleDue

string

Conditional

Amount currently due on account Valid Values: 0-9 Format: $XX.XX Example: $100.00

Allowable Values:

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

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 CardNumber/AdminNumber/AccountNumber/AccountID is required.

TotalDue

decimal

Optional

Total Amount Due as on account Valid Values: 0-9 Format: $XX.XX Example: $150.99

MrSevenCyclesPastDue

decimal

Optional

Amount Seven Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrSixCyclesPastDue

decimal

Optional

Amount Six Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrFiveCyclesPastDue

decimal

Optional

Amount Five Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrFourCyclesPastDue

decimal

Optional

Amount Four Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrThreeCyclesPastDue

decimal

Optional

Amount Three Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrTwoCyclesPastDue

decimal

Optional

Amount Two Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrOneCyclesPastDue

decimal

Optional

Amount One Cycle past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrPastDue

decimal

Optional

Amount past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrCurrentDue

decimal

Optional

Amount current due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrTotalPastDue

decimal

Optional

Total amount past due on the account Valid Values: 0-9 Format: $XX.XX Example: $100.50

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,
  "TypeOfManualReage": 0,
  "TotalDueMethod": null,
  "CycleDueMethod": null,
  "CurrentCycleDue": null,
  "AccountNumber": "0000000000052069",
  "AccountID": 167484,
  "TotalDue": null,
  "MrSevenCyclesPastDue": null,
  "MrSixCyclesPastDue": null,
  "MrFiveCyclesPastDue": null,
  "MrFourCyclesPastDue": null,
  "MrThreeCyclesPastDue": null,
  "MrTwoCyclesPastDue": null,
  "MrOneCyclesPastDue": null,
  "MrPastDue": null,
  "MrCurrentDue": null,
  "MrTotalPastDue": null
}

Response fields details

Fields	Description
TotalDueAdjusted decimal	Total amount due on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
TotalPastDueAdjusted decimal	Total past due amount on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
CurrentDueAdjusted decimal	Current amount due on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
PastDueAdjusted decimal	Past due amount on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
OneCyclePastDueAdjusted decimal	Amount in One cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
TwoCyclesPastDueAdjusted decimal	Amount in Two cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
ThreeCyclesPastDueAdjusted decimal	Amount in Three cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
FourCyclesPastDueAdjusted decimal	Amount in Four cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
FiveCyclesPastDueAdjusted decimal	Amount in Five cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
SixCyclesPastDueAdjusted decimal	Amount in Six cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00
SevenCyclesPastDueAdjusted decimal	Amount in Seven cycle past due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00 Condition:H1497

Sample response body

{
  "Message": "Re-age request has been processed successfully",
  "Status": true,
  "ErrorCode": "ERR01041",
  "ResponseData": {
    "TotalDueAdjusted": 0.0,
    "TotalPastDueAdjusted": 0.0,
    "CurrentDueAdjusted": 0.0,
    "PastDueAdjusted": 0.0,
    "OneCyclePastDueAdjusted": 0.0,
    "TwoCyclesPastDueAdjusted": 0.0,
    "ThreeCyclesPastDueAdjusted": 0.0,
    "FourCyclesPastDueAdjusted": 0.0,
    "FiveCyclesPastDueAdjusted": 0.0,
    "SixCyclesPastDueAdjusted": 0.0,
    "SevenCyclesPastDueAdjusted": 0.0
  }
}