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

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/AccountNumber/AccountID 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

integer

Optional

Indicates the CBR value. Valid Values: Refer Appendix section 5.57 Example: 1 = Yes.

CBRDate

datetime

Mandatory

Indicates the Credit Bureau Reporting date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

SpecialCommentsOverrideValue

string

Optional

Displays the special comments. Valid Values: Refer Appendix section 5.58 Example: A = Account acquired by FDIC/NCUA. AB = Debt being paid through insurance.

Allowable Values:

5

ComplianceConditionCodeOverrideValue

string

Optional

Displays the Compliance code. Valid Values: Refer Appendix section 5.59 Example: NO = None XA = Account closed at consumer's request

Allowable Values:

5

AuthorizedUserCBRIndicator

integer

Optional

Indicates the authorised user. Valid Values: 0 = No, 1 = Yes Example: 0

ClientID

integer

Optional

Client ID of the client. Valid Values: 0-9 Example: 7815

ConsumerInformationIndicator

string

Optional

Bankruptcy Codes for the consumer. Valid Values: Refer Appendix section 5.60

Allowable Values:

10

BankruptcyNotificationDate

datetime

Optional

Indicates Bankrupt notification date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ECOACodes

string

Optional

The ECOA Code defines the relationship of the consumer to the account in compliance with the Equal Credit Opportunity Act. Valid Values: Refer Appendix section 5.36

Allowable Values:

1

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entity, i.e., the Account ID of program card account). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/AccountNumber/AccountID is required.

SpecialCommentsDerivedValue

string

Optional

Displayes the derived value of Compliance Condition Code. Valid Values: 0-9 a-z Example:XA

Allowable Values:

25

ComplianceConditionCodeDerivedValue

string

Optional

Displayes the derived value of Compliance Condition Code. Valid Values: 0 - 9 a-z Example:XA

Allowable Values:

25

SpecialCommentsLastReportedValue

string

Optional

Displayes the Last Reported value of special comment. Valid Values: 0 - 9 a-z Example:AH

Allowable Values:

25

ComplianceLastReportedValue

string

Optional

Displayes the Last reported Value of Compliance Condition Code. Valid Values: 0 - 9 a-z Example:AH

Allowable Values:

25

FCRA1stDateOfDelinquency

string

Optional

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

Allowable Values:

25

BankruptcyFiledDate

datetime

Conditional

Indicates the Bankruptcy File Date. Format: MM/DD/YYYY Example: 01/01/2020 Condition: If on Product Parameter CI > Institution > CBR Report Type is set as ‘Internal’ then this tag is mandatory based on selection of Consumer Information Indicator. If this condition is not satisfied then this tag must be considered as optional.

DateAccountClosed

datetime

Conditional

Indicates the Account Closed File Date. Format: MM/DD/YYYY Condition: Description: Indicates the date when account was closed. Example: 01/01/2020