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). Valid Values : 0-9 Example: 12345 Condition: At least one of AccountID/AdminNumber/AccountNumber is required.

AccountNumber

string

Conditional

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

Allowable Values:

19

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

ApplicantType

integer

Optional

Selects the type of Applicants. Valid Values: 1,2,3,4 Example: 1 = Applicant, 2 = Co-Applicant , 3 = Cosigner , 4 = Secondary Card

CBRIndicator

string

Indicates the CBR value Valid Values: 0-9 Format: xx Example: 1 = Yes

ECOACode

string

Credit Report Details Association Code (ECOA) Valid Values: Refer Appendix section 5.36 Format: xx Example: 1

CBRDate

datetime

Indicates the Credit Bureau Reporting date Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

SpecialCommentsOverrideValue

string

Displays the special comments Valid Values: Refer Appendix section 5.58 Format: xx Example: A = Account acquired by FDIC/NCUA.

Allowable Values:

2

SpecialCommentsDerivedValue

string

Displayes the derived value of Compliance Condition Code Valid Values: a-z Format: xx Example:A = Account acquired by FDIC/NCUA.

Allowable Values:

2

SpecialCommentsLastReportedValue

string

Displayes the Last Reported value of special comment. Valid Values: a-z Format: xx Example: A = Account acquired by FDIC/NCUA.

Allowable Values:

2

ComplianceConditionCodeOverrideValue

string

Displays the Compliance code Valid Values: Refer Appendix section 5.59 Format: xx Example: NO = NONE

Allowable Values:

2

ComplianceConditionCodeDerivedValue

string

Displayes the derived value of Compliance Condition Code. Valid Values: a-z Format: xx Example: NO = NONE

Allowable Values:

2

ComplianceConditionCodeLastReportedValue

string

Displays the Compliance code Valid Values: a-z Format: xx Example: NO = NONE

Allowable Values:

2

CustomerInformationIndicator

string

Indicates the Customer Information Valid Values: 0-9 a-z Format: xx Example:1A

Allowable Values:

100

AuthorizedUserCBRIndicator

string

Indicates the authorised user Valid Values: 0-1 Format:x Example: 0 = No, 1 = Yes

Allowable Values:

5

ClientId

string

Client ID of the client. Valid Values: 0-9 Format:XXXXX Example: 5558547

Allowable Values:

25

CoApplicantDeceased

integer

This tag reflects whether the card holder is deceased or not . Valid Values:0- No, 1 - Yes Example: 0

BankruptcyNotificationDate

datetime

Indicates Bankrupt notification date Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

CoApplicantCBRConsumerInfoIndicator

string

This tag reflect the Co-Applicant consumer information indicator. Valid Values: Format:xx Example:1A

Allowable Values:

2

CbBnkrptNotifDate

string

Indicates Bankrupt notification date Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

Deceased

string

Flag for card holder is deceased or not Valid Values: 0- No, 1 - Yes Format: x Example: 0

Allowable Values:

5

FCRA1stDateOfDelinquency

datetime

1st date of delinquency (Fair Credit Reporting Act) Valid Values: 0 - 9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05