Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Atleast one of AdminNumber/CardNumber is required

CardNumber

string

Conditional

Card Number of account holder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632 Condition: Atleast one of AdminNumber/ CardNumber is required

Allowable Values:

19

ResetLimitFlag

integer

Conditional

Flag to reset card limit Valid Values: Send 1 in this flag if user want to update card's actual limit Example:1 Condition: ResetLimitFlag is mandatory if ResetTxnFlag is null or blank.

CardLimit

decimal

Conditional

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00 Condition : If ResetLimitFlag is true then CardLimit field is mandatory.

ResetTxnFlag

integer

Conditional

Flag to reset card's number of allowed transactions. Valid Values: Send 1 in this flag if user want to update card's number of allowed transactions. Example:true Condition:ResetTxnFlag is mandatory if ResetLimitFlag is null or blank.

NumberAllowedTxn

integer

Conditional

NumberAllowedTxn of virtual card will set to this field value. Condition:If ResetTxnFlag is true then NumberAllowedTxn field is mandatory.

VirtualCardLimitMethod

integer

Optional

Method on which Virtual Card limit is applied e.g. Account / Card. Valid Values: 0 = It means VirtualCardLimitMethod is Account (i.e Virtual Card uses Credit limit of Account) 1 = It means VirtualCardLimitMethod is Card (i.e Virtual Card uses Credit limit of its)

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

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 is required.

ResetLimitFlag

integer

Conditional

Flag to reset card limit. Valid Values: 0-9 Format: x Example: 1 Condition: ResetLimitFlag is mandatory if ResetTxnFlag is null or blank.

CardLimit

decimal

Conditional

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00 Condition : If ResetLimitFlag is true then CardLimit field is mandatory.

ResetTxnFlag

integer

Conditional

Flag to reset card's number of allowed transactions. Valid Values: 0-9 Format: x Example: 1 Condition: ResetTxnFlag is mandatory if ResetLimitFlag is null or blank."

NumberAllowedTxn

integer

Conditional

Number of transaction allowed on Virtual Card. Valid Values: 0-9 Format: x Example: 5 Condition:If ResetTxnFlag is true then NumberAllowedTxn field ismandatory.

VirtualCardLimitMethod

integer

Optional

Method on which Virtual Card limit is applied e.g. Account / Card. Valid Values: 0 = It means VirtualCardLimitMethod is Account(i.e Virtual Card usesCredit limit of Account), 1 = It means VirtualCardLimitMethod is Card(i.e Virtual Card uses Creditlimit of its) Format: x Example: 1

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

CardLimit

decimal

Card Limit of virtual card will set to this field value. Valid Values: Format:XXX.XX Example:500.00

NumberAllowedTxn

integer

NumberAllowedTxn of virtual card will set to this field value. Valid Values:0-9 Format:XX Example:10

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

Allowable Values:

15

CardLimit

decimal

Card Limit of virtual card will set to this field value. Valid Values:0-9 Format:XXX.XX Example:500.00

NumberAllowedTxn

integer

NumberAllowedTxn of virtual card will set to this field value. Valid Values:0-9 Format:XX Example:10

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

Allowable Values:

15