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

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

PageIndex

integer

Optional

Number of page Valid Values:0-9 Format:XX Example:12

Limit

integer

Optional

Limit can have value 1-50,On the basis of Page and Limit paging will be done . Limit can not exceed 50.It means at a time API wont return more than 50 records as a card detail if only account number passed in input. If AdminNumber is passed then Page and Limit parameters will be ignored, As we will have only one record to return. Valid Values:0-9 Format:XXXXX Example:50

AccountUUID

string

Optional

Basesegment's Universal Unique Id. Valid Values:0-9 Format:XXXXX Example:12345

Allowable Values:

64

AdminNumberUUID

string

Optional

EmbossingAccount's Universal Unique Id. Valid Values:0-9 Format:XXXXX Example:12345

Allowable Values:

64

AccountNumber

string

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

AvailableBalance

decimal

Available Balance to make new transactions. Valid Values:0-9 Format:XXX.XX Example:500.00

CurrencyCode

string

Currency Code Example:840 = US Doller

Allowable Values:

3

NumberOfCards

integer

Number of Cards attached to the Account.

CurrentBalance

decimal

Current balance of account.

TotalAmountDue

decimal

Total amount due on Account.

PaymentDueDate

datetime

Due date as to by when payment needs to be made to avoid late fees

FirstName

string

Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1

Allowable Values:

50

MiddleName

string

Card holder's Middle name.

Allowable Values:

40

LastName

string

Card holder's last name.

Allowable Values:

40

AddressLine1

string

Card Holder's address line 1.

Allowable Values:

40

AddressLine2

string

Card holder's address line 2.

Allowable Values:

40

City

string

City name of the Card holder's address.

Allowable Values:

40

State

string

A State of the card holder address.

Allowable Values:

40

PostalCode

string

Postal code of the card holder's address.

Allowable Values:

15

Country

string

Country name of the Card holder's address.

Allowable Values:

40

EmailID

string

This Tag reflects the applicant Email ID.

Allowable Values:

100

DateOfBirth

datetime

This Tag reflects the applicant Email ID.

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server

Allowable Values:

15

GeneratedStatus

string

Account Generated Status.

Allowable Values:

15

ManualAccountStatus

string

Account Manual Status.

Allowable Values:

255

StatementProduction

string

Statement prduction to be process normally, online only or hold statement .

Allowable Values:

50

ClientId

string

Client ID of the account.

Allowable Values:

25

AccountDerivedStatus

string

Derived status based on Account Status, Card Manual Status and Embossing Status. Possible values - Active Blocked Cancelled Disabled

AccountUUID

string

Basesegment's Universal Unique Id.

CardList

array

CardList

PlanList

array

Plan List.