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

MerchantID

integer

Conditional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantNumber not Inputted in API Request

MerchantNumber

integer

Conditional

Merchant Number which is assgined to a Merchant Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantID not Inputted in API Request

Allowable Values:

10

AddPastDue90ToReserve

integer

Optional

Determines Past Due 90 to be Added to the Merchant Reserve or Not Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes

PastDue

integer

Optional

Determines if the Past Due is on Amount or on Balance Amount = Reserve Calculation will be Done on 3 cycle (to 7 cycle past due) past due amount Balance = Reserve calculation on Current Balance Default Value will be '1' = Amount Valid Values: Amount = '1', Balance = '0' Format: X Example: 0 Condition: Functional only if 'AddPastDue90ToReserve' is set to 'Yes'

AddUnmailedtoReserve

integer

Optional

if Set as Yes then Reserve Calculations will be done for the Accounts with statuses as set in the fields 'IncludedAccountStatus1,2,3, 4 and 5', depending the same statuses must be set on Merchant Account Parameters in Fields 'Hold Account Status 1,2,3 and 4' Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes

AddCreditBalancestoReserve

integer

Optional

Determines Credit Balances to be Added to the Merchant Reserve or Not Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes

AddnoFinanceChargeAccountstoReserve

integer

Optional

Determines No Finance Charge Accounts to be Added to the Merchant Reserve or Not Valid Values: '0' = Yes and '1' = No Format: X Example: 0 Condition: If kept Blank Default Value will be considered as '0' = Yes

PercentOfNewBalanceAddToReserve

decimal

Optional

Determines percentage of New Balance to be Added to the Merchant Reserve Valid Values:0-9 Format: XX.XX Example: 10.00%

IncludedAccountStatus1

integer

Optional

Indicates that Account with status will be Included for Reserve Calculations, condition only if the same status is also set in 'HoldAccountStatus' fields in Merchant Account Parameters Valid Values: Refer Appendix Section 5.49 Include/Hold Account Statuses Format: XXX

IncludedAccountStatus2

integer

Optional

Indicates that Account with status will be Included for Reserve Calculations, condition only if the same status is also set in 'HoldAccountStatus' fields in Merchant Account Parameters Valid Values: Refer Appendix Section 5.49 Include/Hold Account Statuses Format: XXX

IncludedAccountStatus3

integer

Optional

Indicates that Account with status will be Included for Reserve Calculations, condition only if the same status is also set in 'HoldAccountStatus' fields in Merchant Account Parameters Valid Values: Refer Appendix Section 5.49 Include/Hold Account Statuses Format: XXX

IncludedAccountStatus4

integer

Optional

Indicates that Account with status will be Included for Reserve Calculations, condition only if the same status is also set in 'HoldAccountStatus' fields in Merchant Account Parameters Valid Values: Refer Appendix Section 5.49 Include/Hold Account Statuses Format: XXX

IncludedAccountStatus5

integer

Optional

Indicates that Account with status will be Included for Reserve Calculations, condition only if the same status is also set in 'HoldAccountStatus' fields in Merchant Account Parameters Valid Values: Refer Appendix Section 5.49 Include/Hold Account Statuses Format: XXX