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

ProductID

integer

Optional

ID assigned to a Program a Specific Product ID is Inputted, then the Applications Created under that Product will be fetched Valid Values:0-9 Format:XXXXX Example:Fixed value provided by CoreCard.

MerchantID

string

Conditional

A unique id generated by corecard sytem for a merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory.

Allowable Values:

10

MerchantNumber

string

Conditional

Merchant Number which is assgined to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory

Allowable Values:

9

AccountNumber

string

Optional

Account number of cardholder/AccountHolder.*if a Specific Account Number is Inputted, then the Account Number specifc Application Details will be fetched Valid Values:0-9 Format :XXXXXXXXX Example:7314145404121234569.

Allowable Values:

19

ApplicationNumber

int64

Optional

Unique Number generated for the Account creation Application .*if a Specific Application Number is Inputted, then the Application Number specific Application Details will be fetched Valid Values:0-9 Example:8002201421.

ApplicationStatus

string

Optional

Status of the Application *if a Specific Application Status is Inputted, then the Status specific Applications Details will be fetched Valid Values: Value="1" Text="Approved" Value="2" Text="Declined" Value="6" Text="Pending" Value="9" Text="Awaiting Decision" Format:X Example:1

Allowable Values:

20

FirstName

string

Optional

First name of account holder*if a Specific Account/Application Holder First Name is Inputted, then the First Name specific Applications Details will be fetched Valid Values:A-Z Format :XXXXX Example:John.

Allowable Values:

50

LastName

string

Optional

Last name of account holder *if a Specific Account/Application Holder Last Name is Inputted, then the Last Name specific Applications Details will be fetched Valid Values:A-Z Format :XXXXX Example:Smith.

Allowable Values:

50

PreQualID

string

Optional

This tag refer to Pre qualification ID.*if a Specific Prequal ID is Inputted, then the ID specific Applications Details will be fetched. Valid Values:0-9 Format:XXXXX Example:10255556

Allowable Values:

10

PreQualStatus

string

Optional

This tag refer to Pre qualification Status.a Specific Prequal Status is Inputted, then the Status specific Applications Details will be fetched Valid Values:0-9Valid Values: 1-4 Value="1" Text="Incomplete PreQual" Value="2" Text="Declined" Value="3" Text="Expired" Value="4" Text="Utilized" Format:X Example:2

Allowable Values:

20

BatchSize

integer

Optional

This Tag Defines how many number of Records will be Fetched in One Batch/Page ,If User didn’t Input any Value, then the Default Value as per System will be 50 Max Value Inputted can be 500. Valid Values:0-9 Format :XXX Example:50 Condition: Default Value will be 50 and Max Value Inputted must not exceed 500

PageIndex

integer

Optional

This Tag Defines which Page Number of the Index of which the Records must be Fetched Valid Values:0-9 Format :XX Example:12 Condition: Default value would be 0

MerchantNumberlist

string

Conditional

User can input one or multiple merchant numbers and get the results accordingly. Valid Values: A-Z, 0-9 Example:"1234,2345,3456" Condition: any one search criteria required

EmailID

string

Optional

Card holder's Email ID. Valid Values:0-9,A-Z Format :XX@XX.Com Example:ABC@gmail.com.

Allowable Values:

300

SSNLast4Digits

string

Optional

Card holder's last four digit of SSN. Valid Values:1120 Format :XXXX Example:1120

Allowable Values:

4

MobilePhoneNumber

string

Optional

Mobile Phone Number. Valid Values:0-9 Format :XXXXXXXXXX Example:987567757

Allowable Values:

15

DateOfBirth

datetime

Optional

Card Holder's Date of Birth. Valid Values:0-9 Format :MM/dd/yyyy Example: 02/01/2020

SearchResult

array

This tag refer to the any search list . *In this API this tag refers to Application Search List