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 Card holder under which secondary card need to be created. Valid Values:0-9 Example:8000000000000037 Condition:At least one account identifier 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 account identifier is required.

VirtualCardLimit

decimal

Conditional

Card limit of Virtual card Valid Values:0-9 Format:XXXX.XX Example:1000.00 Condition:This field is conditional. Virtual Card can be created without passing Virtual card limit, It can be 0 or Null.If it is 0 or Null then card will use Accounts Credit Limit.

VirtualCardResetAllow

integer

Optional

Flag to decide if created virtual card should get the facility to update card limit. Valid Values: 0 = Yes (Will get the facility to update card limit) 1 = No (Will not get the facility to update card limit) Format:X Example:0,1

VirtualCardExpOption

integer

Optional

Virtual card expiration option. Valid Values: 0 = Card expire after no.of transactions. 1 = Card expire on particular duration. 2 = Card expire on particular date. 3 = Card expiry date is same as Primary Card. This field is mandatory when Secondary Card Type is "1"(Virtual). Format: X Example: 2 (Card expire on particular date)

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. Valid Values: 0-9 Format: XX Example: 10 Condition: This field is mandatory when VirtualCardExpOption is 0 (Card expire after no. of transactions)

VirtualCardExpDuration

integer

Conditional

Virtual card expiration duration like hour, minute, day etc Valid Values: 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Format: X Example: 2 (Day) Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDurationValue

integer

Conditional

Virtual card expiration Duration Value. Valid Values: 0-9 Format: XXX Example: Virtual Card Expiry duration is 4(month) then this field value can be of 1-12. Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDate

datetime

Conditional

Virtual card expiration option at exact date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/01/2024 Condition: This field is mandatory when VirtualCardExpOption is 2 (Card expire on particular date)

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

CardImageID

string

Optional

Art/Template ID based on this Card’s Image will be displayed. Valid Values:0-9, a-z Format:XXXX(String) Example:30abc

Allowable Values:

100

VirtualCardAutoReset

integer

Conditional

Flag to decide if Virtual Card Limit will get auto-reset or not. Valid Values: 0 = Yes (Virtual Card Limit will be Auto-Reset) 1 = No(Virtual Card Limit will not be Auto-Reset) Format: X Example: 0,1 Condition: Allowed only if- 1. Virtual Card Limit has a value except 0 or NULL. 2. ‘Usage Reset Frequency’ is set to Billing Cycle at Product Level. 3. If no value is passed, then by default null will be considered as no auto-reset applicable.

VirtualCardNumber

string

Virtual Card Number Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AccountNumber

string

Account number of Card holder under which secondary card created. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037

Allowable Values:

19

AdminNumber

int64

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

CurrentCardBalance

decimal

Available Balance of Card. Valid Values:0-9 Format:XXX.XX Example:2000.00

FirstName

string

Card holder's First name. Example:John

Allowable Values:

50

LastName

string

Card holder's last name. Example:Smith

Allowable Values:

50

NameOnCard

string

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

PrimaryCardExpiryDate

datetime

Expiry date of primary card under which secondary card is being created. Valid Values:0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ValidFrom

datetime

Card Creation Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2020

ValidTo

datetime

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CVC

string

3 Digit security number printed on back side of the card. Valid Values:0-9 Format:XXX Example:456

Allowable Values:

3

VirtualCardExpirationDate

datetime

Card Expiration Date of Virtual card. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05