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

DecisionFlag

string

Mandatory

Flag decides the type of transaction. Valid Values: 0- Sales 1-Return Example: 1

Allowable Values:

2

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one Account identifier input parameter should be passed.

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 Account identifier input parameter should be passed.

MerchantNumber

string

Mandatory

Merchant Number which is assgined to a Merchant, Mandatory If MerchantID not Inputted in API Request Valid Values:0-9 Format: XXXXXXXXX Example: 205136549

Allowable Values:

9

StoreNumber

string

Mandatory

Unique Number which is assigned to a Store. Valid Values:0-9 Example: 205136549

Allowable Values:

10

RegisterNumber

string

Mandatory

Unique Number which is assgined to a register. Valid Values:0-9 Example: 205136549

Allowable Values:

10

Operator

string

Mandatory

SpecialMerchantIdentifier as TransactionCode Internal

Allowable Values:

50

SpecialPlans

string

Optional

ID of Plan which can be applied for the Transaction. Valid Values:0-9 Example: 1234

Allowable Values:

10

NonDetailedTxnAmount

decimal

Conditional

Transaction Amount Ex: 50.02

InventoryDetails

array

Optional

Array to capture the purchase/return line item.

NonDetailedTxnDescription

string

Conditional

User defined description of transaction. Valid Values: A-Z 0-9 Example: TestInventory Condition:If DecisionFlag = 0 then either NonDetailedTxnDescription or InventoryDetails Array details needs to be provided.

DiscountAmount

decimal

Optional

Amount which will deduct from Total Transaction Amount as a discount. Valid Values:0-9 Example:10.00

TaxAmount

decimal

Conditional

Purchase Amount for PLAdditional Table if greater than 0

TotalAmount

decimal

Conditional

Transaction Amount if source is Sales

InventoryTranID

string

Mandatory

Transaction ID for initiating the Inventory order.

Allowable Values:

20

PostedPlan

string

Name of the Plan with which transaction is initiated. Valid Values:0-9, A-Z Example:RegularPurchasePlan

Allowable Values:

50

PostedPlan

string

Name of the Plan with which transaction is initiated. Valid Values:0-9, A-Z Example:RegularPurchasePlan

Allowable Values:

50