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:XXXXXXXXXX Example:7314145404 Condition:At least one of CardNumber/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 CardNumber/AdminNumber/AccountNumber is required.

CardNumber

string

Conditional

Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:At least one of CardNumber/AdminNumber/AccountNumber is required.

Allowable Values:

19

BankAccountType

integer

Optional

Type of Bank account added by customer for card payment,0=checking and 1=saving Valid Values:0,1 Format:X Example:0,1

BankAccountNumber

string

Conditional

Bank Account Number Valid Values:00000001234567891 Format:XXXXXXXXXXXXXXXXX Example:00000001234567891 Condition:Mandatory when Request Type is 0 i.e Add.

Allowable Values:

17

BankRoutingNumber

string

Conditional

Bank Rrouting number identifies the location of the bank's branch Valid Values:111000038 Format:XXXXXXXXX Example: 111000038 Condition:Mandatory when Request Type is 0 i.e Add.

Allowable Values:

9

BankName

string

Conditional

Name of the Bank Valid Values: A-Z Format:XXXXXXXXXX Example:ABC Corporation Condition:Mandatory when Request Type is 0 i.e Add.

Allowable Values:

100

CreditBalanceRefund

integer

Optional

Flag to tag the bank account for credit balance refund ,Only and Only one Bank Account can be 1 (Yes) of an Account. Valid Values:0-No, 1-Yes. Example: 1

RequestType

string

Optional

Request Type defines the action to be perform in Bank Account. Possible value would be (0 : Add, 1 : Delete, 2 : Update) Valid Values:0 Add 1 Delete 2 Update Format:X

MethodName

int64

Conditional

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. Required if request type = 1 or 2 (Update or delete request.) Valid Values:0-9 Format:XXXX Example:4092

ApplicantType

integer

Optional

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

UniqueId

string

Optional

Unique ID is a transaction specific unique ID. This ID is unique for every transaction. If multiple calls are made by client for a specific transaction, the value of this tag will always be the same for a specific transaction. (GUID and UUID datatypes are supported for this tag). Valid Values: A-Z, 0-9 Example: F965C56F-C58F-EC11-B80E-A4BF010A357E Condition:For API user, if API Idempotency Applicable is set as Yes on CoreCredit, field is mandatory. The UniqueId is valid for 7 days from first submission of the request. Same request can be retried for 7 days without performing the same action twice.Idempotency will be checked at the belongingOwning Partner and Merchant Level.

Allowable Values:

40

OverrideBankVerificationMethod

integer

Optional

Value in this tag will override the default Program set up of bank verification method. If blank, then default Program level set up will be honoured. Valid Values: 0=None, 1=PreNote, 2=MicroDeposit, 3=ThirdPartyValidation Example: 0

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking

MethodName

int64

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. Required if request type = 1 or 2 (Update or delete request.) Valid Values:0-9 Format:XXXX Example:4092