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 Example: 12345 Condition: At least one of AccountNumber or AdminNumber is required.

AccountNumber

string

Conditional

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber or AdminNumber is required.

Allowable Values:

19

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

TotalAmountDue

decimal

Total amount due as on statement date. Example: 200.00

CurrentBalance

decimal

Current balance of account. Example: 200.00

PaymentDueDate

datetime

Due date as to by when payment needs to be made to avoid late fees. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

LastPaymentAmount

decimal

Last payment amount on the account. Example: 200.00

LastPurchaseAmount

decimal

Last Purchase Amount as on statement date. Example: 200.00

RecentPurchasesAndDebits

decimal

Purchase and Debits made on current statement recently. Example: 200.00

RecentPaymentsAndCredits

decimal

Payments and Credits made on current statement recently. Example: 200.00

LastStatementBalance

decimal

Balance of previous statement. Example: 200.00

NextStatementDate

datetime

Next Date for Statement Generation. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

CreditLimit

decimal

Total Credit Limit on account. Example: 200.00

MaskedCardNumber

string

Masked Card Number. Format: XXXX XXXX XXXX XXXX Example: 4567 89XX XXXX 0123

Allowable Values:

19

AvailableCreditLimit

decimal

Total Credit limit minus the total amount due. Example: 200.00

LastPaymentDate

datetime

Date of last payment transaction. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

PreviousStatementDate

datetime

Date of Previous Statement. Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

BeginningRewardBalance

decimal

Reward balance at the beginning of Statement. Example: 200.00

RewardEarned

decimal

Reward Earned in statement Cycle. Example: 200.00

RewardRedeemed

decimal

Reward points Redeemed in statement Cycle. Example: 200.00

AvailableRewardBalance

decimal

Number of Available Reward Balance. Example: 200.00

RewardExpired

decimal

Number of Expired Rewards. Example: 200.00

RewardForfeited

decimal

Number of Forfeited Rewards. Example: 200.00

CustomerID

string

This tag reflects the customer ID. Example: 12345

Allowable Values:

50

CardNumberLast4Digit

string

Last 4 digits of card number. Example: 1234

Allowable Values:

4

CardStatus

string

This tag reflects the status of the card. Example: Active

Allowable Values:

50

CurrencySymbol

string

This tag reflects the currency symbol