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

MrPaymentLevel

string

Mandatory

Signifies if Reage is to be applied at account or plan level Valid Values: Account/Plan Format: XXX Example: Account

Allowable Values:

10

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 account identifier is required.

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

TypeOfManualReage

integer

Mandatory

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

CycleDueMethod

integer

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

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

TotalDue

decimal

Optional

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

MrCurrentDue

decimal

Optional

Amount current 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

MrOneCyclesPastDue

decimal

Optional

Amount One 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

MrThreeCyclesPastDue

decimal

Optional

Amount Three 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

MrFiveCyclesPastDue

decimal

Optional

Amount Five 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

MrSevenCyclesPastDue

decimal

Optional

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

TotalPastDueAdjusted

decimal

Optional

Total Past due amount on the account after adjustment in account reaging. Valid Values: 0-9 Format: $XX.XX Example: $100.50

MrTotalPastDue

decimal

Optional

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

TotalDueAdjusted

decimal

Optional

Total amount due on the account adjusted in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00

CurrentDueAdjusted

decimal

Optional

Current amount due on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.00

PastDueAdjusted

decimal

Optional

Past due amount on the account after adjustment in account reaging Valid Values: 0-9 Format: $XX.XX Example: $100.50

OneCyclePastDueAdjusted

decimal

Optional

One Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

TwoCyclesPastDueAdjusted

decimal

Optional

Two Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

ThreeCyclesPastDueAdjusted

decimal

Optional

Three Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

FourCyclesPastDueAdjusted

decimal

Optional

Four Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

FiveCyclesPastDueAdjusted

decimal

Optional

Five Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

SixCyclesPastDueAdjusted

decimal

Optional

Six Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

SevenCyclesPastDueAdjusted

decimal

Optional

Seven Cycle Past Due after adjusted. Ex: 0 Valid Values: 0-9 Format: $XX.XX Example: $100.50

CustomerServiceReage

integer

Optional

Customer Service Re-age Selection will not increase the normal reage counter of account. Valid Values: 0-No,1-Yes Example: 1