Category links

API Links

Account Balances

You can use the CoreCard API to get balance details about a current account cycle; from the previous cycle; and for the current day, month to date, year to date, or life to date. You can also view the balance after a transfer; total fee details; the interest charged details; the total outstanding amount; and various fee amounts that have been charged over the period on the account due to charge-offs, cash advances balances, debit balances, and credit balances (see the GetAccountBalances API).

Get Running Balance Report

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetRunningBalanceReport

POST /api/CoreCredit/AccountManagement/GetRunningBalanceReport

Use this API to obtain the running balance on a card account via the account number. Details such as the transaction amount, transaction ID, and transaction description are also available.

Request fields detail
Fields Description

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 Default: en - English

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

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

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one of the Account number or Account Id is required. <Reuired>M</Reuired>

Sample request body
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "1000000700000093"
}
Response fields detail
Fields Description

RunningBalanceReportList

array

Header of Running balance report array.

Sample response body

{
  "application/json": {
    "Message": "success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "RunningBalanceReportList": [
        {
          "AccountNumber": "1000000700000093",
          "TransactionAmount": 114.48,
          "RunningBalance": 114.48,
          "TransactionID": 187819,
          "LogicModule": "02",
          "PostTime": "12/16/2014 00:00:00",
          "DebitCreditIndicator": "Debit",
          "TransactionDescription": "614 =  BILLED FINANCE CHARGES",
          "CardAcceptorNameLocation": null
        }
      ]
    }
  }
}

Get Account Balance

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAccountBalance

POST /api/CoreCredit/AccountManagement/GetAccountBalance

Use this API to retrieve information related to account balances, such as current balance, available reward balance, last payment amount and date, total amount due, and beginning reward balance.

Request fields detail
Fields Description

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 Default: en - English

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

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

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": null,
  "AdminNumber": 61992
}
Response fields detail
Fields Description

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

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "TotalAmountDue": 0.0,
      "CurrentBalance": 1000.0,
      "PaymentDueDate": null,
      "LastPaymentAmount": 0.0,
      "LastPurchaseAmount": 0.0,
      "RecentPurchasesAndDebits": 0.0,
      "RecentPaymentsAndCredits": 0.0,
      "LastStatementBalance": 0.0,
      "NextStatementDate": "03/23/2020 00:00:00",
      "CreditLimit": 1500.0,
      "MaskedCardNumber": "461668XXXXXX1592",
      "AvailableCreditLimit": 1500.0,
      "LastPaymentDate": null,
      "PreviousStatementDate": null,
      "BeginningRewardBalance": 0.0,
      "RewardEarned": 0.0,
      "RewardRedeemed": 0.0,
      "AvailableRewardBalance": 0.0,
      "RewardExpired": 0.0,
      "RewardForfeited": 0.0,
      "CustomerID": "44570",
      "CardNumberLast4Digit": "1592",
      "CardStatus": "Active"
    }
  }
}

Get Account Charge-off Balances

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetAccountChargeOffBalances

POST /api/CoreCredit/AccountManagement/GetAccountChargeOffBalances

Use this API to retrieve all the charge-off balances, recovery fees, pending fees, late fees, annual fees etc. for a card account.

Request fields detail
Fields Description

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 Default: en - English

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

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 cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AccountID/AdminNumber is required.

Allowable Values:

19

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one of AccountNumber/AccountID/AdminNumber is required.

AdminNumber

int64

Conditional

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

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "8000000000000029",
  "AccountID": 167494,
  "AdminNumber": 129363
}
Response fields detail
Fields Description

BalanceCO

decimal

Balance on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

PrincipalATCO

decimal

Principal amount of loan at time of account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsufficientFeesATBNPCO

decimal

Pending fees on bill not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

LateFeesBNPATCO

decimal

Late fees on billing not paid at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InsuranceFeesBNPATCO

decimal

Insurance fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

InterestBNPATCO

decimal

Interest on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

TransactionFeesBNPATCO

decimal

Transaction fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

AnnualFeesBNPATCO

decimal

Annual fees on bill not paid at charge off of account Valid Values: 0-9 Format: $XX.XX Example: $100.00

RecoveryFeesBNPATCO

decimal

Recovery fees on bill not paid at charge off on account Valid Values: 0-9 Format: $XX.XX Example: $100.00

OverlimitFeesBNPATCO

decimal

Overlimit fees on bill not paid on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CollectionFeesBNPATCO

decimal

Collection fees on bill not paid on account at charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

CashBalanceCO

decimal

Cash Balance on account at account charge off Valid Values: 0-9 Format: $XX.XX Example: $100.00

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "BalanceCO": 0.0,
      "PrincipalATCO": 0.0,
      "InsufficientFeesATBNPCO": 0.0,
      "LateFeesBNPATCO": 0.0,
      "InsuranceFeesBNPATCO": 0.0,
      "InterestBNPATCO": 0.0,
      "TransactionFeesBNPATCO": 0.0,
      "AnnualFeesBNPATCO": 0.0,
      "RecoveryFeesBNPATCO": 0.0,
      "OverlimitFeesBNPATCO": 0.0,
      "CollectionFeesBNPATCO": 0.0,
      "CashBalanceCO": 0.0
    }
  }
}

Credit Balance Refund

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/CreditBalanceRefund

POST /api/CoreCredit/AccountManagement/CreditBalanceRefund

Use this API to initiate a credit balance refund that could have occurred due to card payer overpayment or another condition. Additionally, this API enables a user to select the mode, such as ACH or other, by which a credit balance refund is performed.

Request fields detail
Fields Description

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 Default: en - English

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

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 cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one Account identifier input parameter should be passed

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 input parameter should be passed

CreditBalance

decimal

Mandatory

The amount which has to be refunded Valid Values:0-9 Format:XX.XX Example:22.00

RefundMode

integer

Mandatory

Mode how the balance has been refund.like ACH, manual,other Valid Values:0,1 Format:XXXXXXXXXXXXXXXX Example:0 = ACH OR 1 = Other

MethodName

int64

Conditional

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. This is required If User wants to send transaction in ACH. Valid Values:0-9 Format:XXXX Example:4092 Condition: If Payment mode is ACH then only Methodname is required.

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "5000000000011550",
  "AdminNumber": 62065,
  "CreditBalance": 364.6,
  "RefundMode": 0,
  "MethodName": 2881
}
Response fields detail
Fields Description

ErrorNumber

string

Error Code which has been defined for the API response. Valid Values:0-9, A-Z Format:XXXXX Example:ERR01013

ErrorMessage

string

Error Message which has been defined for the Error Codes,like ERR01013 -Credit balance refund retrieved successfully . Valid Values:0-9, A-Z Format:XXXXX Example:Credit balance refund retrieved successfully

ErrorFound

string

Error is been there in the API response. Valid Values:Y/N Format:XXXXX Example:Yes/No

Sample response body

{
  "application/json": {
    "Message": "Credit balance refund retrieved successfully.",
    "Status": true,
    "ErrorCode": "ERR01013",
    "ResponseData": null
  }
}

Search Credit Balance Refund

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/SearchCreditBalanceRefund

POST /api/CoreCredit/AccountManagement/SearchCreditBalanceRefund

Use this API to fetch the list of credit balance refunds made to an account. It returns details such as refund date time, amount, user, mode, and bank name.

Request fields detail
Fields Description

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 Default: en - English

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

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

Optional

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

Allowable Values:

19

AdminNumber

int64

Optional

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

CardNumber

string

Optional

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "5000000000011071",
  "AdminNumber": null,
  "CardNumber": null
}
Response fields detail
Fields Description

CreditBalanceRefundList

array

Array/List of credit balance refund transactions.

Sample response body

{
  "application/json": {
    "Message": "Credit balance refund retrieved successfully",
    "Status": true,
    "ErrorCode": "ERR01013",
    "ResponseData": {
      "CreditBalanceRefundList": [
        {
          "RefundDateTime": "12/13/2016 23:03:15",
          "InitiatedBy": "Victoria.Krauchunas",
          "RefundAmount": 1071.0,
          "RefundMode": "0",
          "BankName": "2816"
        }
      ]
    }
  }
}

Check Account Balance

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/CheckAccountBalance

POST /api/CoreCredit/AccountManagement/CheckAccountBalance

Use this API service to check the current card account balance by providing the account number, card number, or admin number.

Request fields detail
Fields Description

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 Default: en - English

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

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

CardNumber

string

Conditional

Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236

Allowable Values:

19

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

Allowable Values:

19

Sample request body
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "CardNumber": null,
  "AdminNumber": 5626,
  "AccountNumber": ""
}
Response fields detail
Fields Description

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

AccountBalance

decimal

Balance available on card holder's account.

Sample response body

{
  "application/json": {
    "Message": "Account Balance details returned Successfully",
    "Status": true,
    "ErrorCode": "ERR01001",
    "ResponseData": {
      "ResponseID": "56944624",
      "AccountBalance": 66000.0
    }
  }
}