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

StoreID

integer

Optional

Unique Number which is assgined to a Store. Valid Values:0-9 Example:1234

RegisterID

string

Optional

Unique ID assigned to a Register. Valid Values:a-z 0-9 Example:123456

Allowable Values:

50

AccountNumber

string

Conditional

Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

TransactionCurrencyCode

string

Mandatory

Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840

Allowable Values:

3

TransactionDescription

string

Optional

User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Example:Purchase/Payment.

Allowable Values:

100

TransactionCode

string

Mandatory

A code to identify type of payment. Valid Values: The valid values of Transaction Code can be fetched from GetTranCodeByUserID API. Example:427248 = Principal Adjustment

Allowable Values:

20

ProductCode

string

Optional

Specific code assigned to the product. Valid Values: Refer Section 5.47 of Appendix Example: 12456

Allowable Values:

50

SettlementDate

DateTime

Optional

Date of Settlement. Valid Values:0-9 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TransactionAmount

decimal

Mandatory

Amount of Transaction. Valid Values:0-9 Format:XXX.XX Example:500.00

CreditPlanMaster

string

Optional

Plan name associated with the card account. Valid Values: 0-9 Example:6051

Allowable Values:

50

PaymentReferenceID

string

Optional

Refernce ID of the Payment. Valid Values:0-9, A-z Format:XXXXXXXXXXX Example:fy76869878gh

Allowable Values:

36

TransmissionDateTime

DateTime

Optional

Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10

EffectiveDateTime

DateTime

Optional

Effective Date of Transaction Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MerchantType

string

Optional

Type of Merchant Valid Values:a-z Example: Retail,Hospital

Allowable Values:

50

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 Condition:At least one of AdminNumber/AccountNumber is required.

ReversalTargetTranID

string

Optional

Transaction number of target transaction which is going to be reversed. Valid Values: 0-9 Example:12345

Allowable Values:

20

ReturnTransactionID

int64

Optional

Transaction ID generated for The Return Transaction. Valid Values:0-9 Example:122390308

MethodName

string

Optional

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account.This is required If User wants to send transaction in ACH. Valid Values:0-9 Example:4092

Allowable Values:

25

MerchantNumber

string

Optional

Number which is assigned to a Merchant. Valid Values: 0-9 Example:11642

Allowable Values:

9

InvoiceNumber

string

Optional

Incoice Number for Transaction. Valid Values: A-Z 0-9 Example: AB987567757

Allowable Values:

50

FeeReversalReason

string

Optional

Reason for Fee Reversal. Valid Values: 0 - Customers Goodwill , 1- Erroneous charges Example: 0 - Customers Goodwill

Allowable Values:

1

CheckNumber

string

Optional

Number of the Payment Check. Valid Values:0-9 Format:XXXXXXXX Example:89874545

Allowable Values:

15

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

AllowForcePost

string

Optional

To Force Post a Transaction. Valid Values: 0,1 Format: X Example: 0 = No, 1 = Yes

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

InterestPlanID

integer

Optional

Interest Plan Id defined on Interest Tables. Valid Values :0-9, A-z Example: 1233 Condition: Interest Plan Override setup should be enabled at Plan

CreditPlanMaster

string

Plan name associated with the card account. Valid Values: 0-9 Example:6051

Allowable Values:

50

PostingReference

string

Posting reference (Like -Transaction Posted Successfully)

Allowable Values:

100

PostingFlag

string

With certain IDs in response, It confirms the posting of transaction. Example:1 = Success,0 failed

Allowable Values:

1

TransactionAmount

decimal

Amount of Transaction. Valid Values: 0-9 Example:500.00

AccountNumber

string

Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122

TransactionID

int64

Transaction Number for the transaction being posted. Valid Values:0-9 Example:23654789

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 Valid Values:0-9 Example:478585

Allowable Values:

15

StoreID

integer

Specific code assigned to a Store. Valid Values:0-9 Example:1234

TransactionCurrencyCode

string

Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840

Allowable Values:

3

PostingDateTime

datetime

Date and Time of posting of the transaction. Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TransactionDescription

string

User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Example:Purchase/Payment.

Allowable Values:

100

TransactionCode

string

A code to identify type of payment. Valid Values: A-Z 0-9 Example:427248 = Principal Adjustment

Allowable Values:

20

TransmissionDateTime

datetime

Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10

CurrencySymbol

string

This tag reflects the currency symbol