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

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.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AccountID/AdminNumber is required.

Allowable Values:

19

RatificationMethod1

integer

Identifies the ratification method. Valid Values: 0 = Normal 1 = Grandfathered 2 = Statement

PaymentType

string

Type of the Payment. Valid Values: 0 = Bill Balance 1 = Bill Fixed Amount 2 = Bill Fixed Percent 3 = Bill Invoice 4 = Bill Fixed Percent Of High Balance Example:0 = Bill Balance

Allowable Values:

50

FixedPaymentAmount

decimal

Fixed amount define for Bill Fixed amount payment type. Valid Values:0-9 Format:XXXX.XX Example:1000.00 Condition: This field is mandatory when Payment type is Bill Fixed amount.

FixedPaymentPercentage

decimal

Percent of principal define for Bill Fix Percent payment type. Valid Values:0-9 Format:XX.XX Example:1.00 Condition: This field is mandatory when Payment type is Bill Fix Percent.

PaymentLevel

string

Define the level of Payment terms calculation. Valid Values: 0 = Account 1 = Plan 2 = Combined Example:0 = Account

Allowable Values:

25

GracePeriod

integer

Define the Grace Period Valid Values: 0-9 Format:XX Example:25

PaymentHoldSkipCheck

integer

EligibleForAutoSkipPaymentOpt

string

Define if Account is Eligible for Automatic skip of payment, Valid Values: 0 = Eligible 1 = Not Eligible

Allowable Values:

25

CashLimitMethod

string

Cash limit method can be set to Amount or Percent of total credit line. Valid Values: 0 = Amount 1 = Percent of Total Credit Line

Allowable Values:

25

CashLimitPercentage

decimal

Percent of total credit limit set for Percent cash limit method. Valid Values: 0-9 Format: XX.XX Example:1.00 Condition: This field is mandatory when Cash limit method is Percent

CashLimitAmount

decimal

Amount set for Amount cash limit method. Valid Values: 0-9 Format: XXXX.XXX Example:1000.00 Condition: This field is mandatory when Cash limit method is Amount.

BillingTable

integer

Name of Billing table assigned to account. Valid Values: Format:ABC_FICO_XXX_XXX Example: ABC_FICO_740_749