Category links

API Links

Transactions

A transaction is referred to the activity which impacts the financial state of a card account. The transaction can be initiated by the cardholder or card issuer to pay the amount of money to each other as per the agreed terms.

As a card issuer/processor, you can utilize the CoreCard system to issue cards and process various transaction types received within the closed-loop environment or from an open network to fulfill different purposes such as purchase, credit, adjustment, transfer, etc.

Usually, the CoreCard system receives a transaction when a cardholder utilizes his card at a merchant terminal or online to make any purchase. These kinds of transactions are initiated by the merchant and routed to the CoreCard system for validation and processing.

If a purchase is initiated from an open network, then the transaction is routed via the card network initially to get an authorization and subsequently submitted with a clearing to debit the funds from the cardholder’s account whereas if it is received from network merchants (close loop environment), then you can route it via APIs which will be validated and posted accordingly in the system.

In some situations, the merchant may process the purchase reversals or refunds for an initially authorized or cleared transaction. These transactions are treated similarly to purchase transactions when received from an open network or from a merchant network.

CardLoad

Action: POST

Endpoint: /api/CardLoad

POST /api/CardLoad

Use this API to load the funds on the cardholder account using card/proxy number along with the load amount.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

TransactionAmount

decimal

Mandatory

Transaction Amount to be posted Valid value 0-9 Example: 300, 3.5 Condition: Not considered for the multi wallet products.

TransactionReceiptFee

decimal

Optional

Transaction Receipt Fee Valid Values: 0-9 Format: $XX.XX Example: $100.50 Condition: The tag should be conditional as per the product set up Note:This tag should be product driven.It should display the value defined in the branch in response. If some value is passed in input tag, then it should display the value that is passed in input tag else it should display the value defined in branch

UniqueTransactionID

string

Optional

Unique Number entered for Transaction which is used in duplicacy check Example : :AAA123456789

Allowable Values:

12

BranchCode

string

Optional

Branch code from where the card was issued. Valid Values:0-9 Example:1006

Allowable Values:

20

NotesReason

string

Optional

PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

50

Notes

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

396

WalletLoadDetails

array

Optional

Sample Request Body 
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "",
  "ProxyNumber": "1314932",
  "TransactionAmount": 20.0,
  "TransactionReceiptFee": 10.0,
  "UniqueTransactionID": "",
  "BranchCode": "",
  "NotesReason": "10",
  "Notes": "Card  Resent: Mailed to Different Address",
  "WalletLoadDetails": [
    {
      "WalletID": 89456,
      "WalletLoadAmount": 20.0
    }
  ]
}
Response Fields Detail
Fields Description

ReceiptID

string

Receipt ID of a transaction

Allowable Values:

19

TransactionID

string

Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369

Allowable Values:

19

AvailableBalance

decimal

Available balance on the account Valid values : 0-9 Example: 100.50

TransactionReceiptFee

decimal

Transaction Receipt Fee Valid Values: 0-9 Format: $XX.XX Example: $100.50

WalletLoadDetails

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "ReceiptID": "",
    "TransactionID": "2153609837",
    "AvailableBalance": 2.0,
    "TransactionReceiptFee": 20.0,
    "WalletLoadDetails": [
      {
        "WalletID": 345627,
        "WalletLoadTransactionID": ""
      }
    ]
  }
}

CardToBankAccountTransfer

Action: POST

Endpoint: /api/CardToBankAccountTransfer

POST /api/CardToBankAccountTransfer

Use this API to transfer funds from card account to external bank Account only when the status of bank account and card is active. A valid card number and transaction amount should be provided as input for a successful transfer.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

DecisionFlag

string

Mandatory

Used for performing various operations when respective flag values defined below are passed. 1 = To Get Recipient ID, Recipient Name and Nick Name etc. 2 = Fund Transfer from Card to Bank. 3 = Adding a new Recipient Bank Account. 4 = Fund Transfer from Card to Bank by given Recipient Bank Account information. 5 = Delete Recipient Bank Account information. 6 = Get Recipient Bank Account information. 7 = Update Recipient Bank Account information. 8 = Set Recipient Bank Account Active/Inactive.

Allowable Values:

2

TransferType

string

Mandatory

Type of money transfer. Valid values: 0 = Card To Bank 1 = Bank To Card Example: 0 Condition :0 (Card To Bank) is applicable for decision flags 1,2,3,4,5,6,7 and 8. 1 (Bank To Card) is applicable for decision flags 1,3,5 and 7 only.

Allowable Values:

1

FromCardNumber

string

Conditional

Clear Card Number of the cardholder from where a transaction is initiated. Valid values: 0-9 Example: 123456******0001 Condition : At least one of From Card Number/ From Proxy Number is required.

Allowable Values:

16

FromProxyNumber

string

Conditional

Proxy Number of the cardholder from where a transaction is initiated Valid values:0-9 Example:1005 Condition : At least one of From Card Number/ From Proxy Number is required.

Allowable Values:

19

RecipientId

Int64

Conditional

UniqueID of Recipient. Valid Values:0-9 Example:1234567890 Condition: It is Mandatory when DecisionFlag = 2,5,6,7 and 8

RecipientName

string

Conditional

First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick Condition: It is mandatory for below scenario: DecisionFlag = 3 and TransferType = 1 or 0, DecisionFlag = 4 and TransferType = 0

Allowable Values:

50

AccountNickName

string

Conditional

Nick name of the account Valid Values:A-Z,a-z Example: Sem Condition: It is mandatory when DecisionFlag = 3 and 4.

Allowable Values:

50

TranactionAmount

decimal

Optional

Transaction Amount Valid Values: 0-9 Example:100.11 Condition:It is Mandatory when DecisionFlag = 2 and 4.

AccountType

string

Conditional

Type of account. Valid Values: 0 = Checking 1 = Savings Example:0 Condition: It is Mandatory when DecisionFlag =3 and 4.

Allowable Values:

9

ConfirmBankAccountNumber

string

Conditional

Re-enter Cardholder's Bank Account Number for confirmation Valid Values:0-9 Example: 1122345678 Condition: It is Mandatory when DecisionFlag =3,4 and 7

Allowable Values:

17

BankAccountNumber

string

Conditional

Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678 Condition: It is Mandatory when DecisionFlag =3,4 and 7

Allowable Values:

17

RoutingNumber

string

Conditional

Bank Routing Number Valid Values:0-9 Example:0110000015 Condition: It is Mandatory when DecisionFlag = 3,4 and 7

Allowable Values:

9

ReasonDescription

string

Optional

Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

50

Note

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

396

BankStatus

string

Conditional

Status of Bank Account. Valid Values :1 = Active 0 = Inactive Example : 1 Condition: It is mandatory for Decision Flag = 8.

Allowable Values:

1

ExternalBankStatus

string

Conditional

External Bank Account Status. Valid Values: 0-7 Example:1 (Validated) Appendix Section:ExternalBankStatus Condition: It is Mandatory when DecisionFlag = 7 or 3

Allowable Values:

2

SameDayACHType

string

Optional

For sending transaction in Same Day ACH file, use this field. Valid values: SD1300 or SD1700 Example: SD1300

Allowable Values:

6
Sample Request Body 
{
  "APIVersion": "1.5",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "DecisionFlag": "1",
  "TransferType": "0",
  "FromCardNumber": "",
  "FromProxyNumber": "1316605",
  "RecipientId": 176270,
  "RecipientName": "Harshal",
  "AccountNickName": "",
  "TranactionAmount": 20.0,
  "AccountType": "1",
  "ConfirmBankAccountNumber": "60000000027166",
  "BankAccountNumber": "60000000027166",
  "RoutingNumber": "061120835",
  "ReasonDescription": "",
  "Note": "",
  "BankStatus": "1",
  "ExternalBankStatus": "",
  "SameDayACHType": "SD1700"
}
Response Fields Detail
Fields Description

TransactionId

Int64

Transaction ID of Debit Transaction on Source Card.

BankAccountNumber

string

Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678

Allowable Values:

11

AccountType

string

Type of account. Valid Values: 0 =Checking 1 =Savings Example:0

Allowable Values:

3

RoutingNumber

string

Bank Routing Number Valid Values:0-9 Example:0110000015

Allowable Values:

9

FinancialInstituteName

string

Name of Financial Institution Valid Values:A-Z,a-z Example:FEDERAL RESERVE BANK

Allowable Values:

200

RecipientName

string

First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick

Allowable Values:

50

RecipientNameId

array

List of Recipient Name Id.

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransactionId": 2154696549,
    "BankAccountNumber": "60000000027166",
    "AccountType": "1",
    "RoutingNumber": "061120835",
    "FinancialInstituteName": "FIRST COVENANT BANK",
    "RecipientName": "Harshal",
    "RecipientNameId": [
      {
        "RecipientId": 175937,
        "AccountNickName": "Harsh",
        "RecipientName": "Harshal",
        "AddedBankStatus": "",
        "TransferType": "1"
      }
    ]
  }
}

CardToCardTransfer

Action: POST

Endpoint: /api/CardToCardTransfer

POST /api/CardToCardTransfer

Use this API to transfer funds between different card accounts. The source card number and destination card number should be provided along with the transaction amount in the API input. After successful transfer API returns the transaction ID of the debit posted on the source card account and transaction ID of the credit posted on destination card account.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

FromCardNumber

string

Conditional

Clear Card Number of the cardholder from where a transaction is initiated. Valid values: 0-9 Example: 123456******0001 Condition : At least one of From Card Number/ From Proxy Number is required.

Allowable Values:

16

FromProxyNumber

string

Conditional

Proxy Number of the cardholder from where a transaction is initiated Valid values:0-9 Example:1005 Condition : At least one of From Card Number/ From Proxy Number is required.

Allowable Values:

19

ReciepientCardNumber

string

Conditional

Card Number of receipient. Valid values: 0-9 Clear Card Number Example: *********4567[For Compliance masked BIN and Extended BIN] Condition : At least one of Recipient Card Number/Recipient Proxy Number is required.

Allowable Values:

16

RecipientProxyNumber

string

Conditional

Proxy Number of recipient Valid Values:0-9 Example: 1001741741741 Condition : At least one of Recipient Card Number/Recipient Proxy Number is required.

Allowable Values:

19

Amount

decimal

Mandatory

Amount to be posted. Valid value 0-9. Example : 300, 3.5

UniqueID

string

Optional

Unique Number entered for Transaction which is used in duplicacy check Example : :AAA123456789

Allowable Values:

12

UniqueIDFlag

string

Optional

Reserved for future use

Allowable Values:

1
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "FromCardNumber": "",
  "FromProxyNumber": "1316610",
  "ReciepientCardNumber": "4066846120012751",
  "RecipientProxyNumber": "1316605",
  "Amount": 20.0,
  "UniqueID": "",
  "UniqueIDFlag": ""
}
Response Fields Detail
Fields Description

FromCardTransactionId

string

Transaction ID of Debit Transaction on Source Card. Example : 147852369

Allowable Values:

0

ToCardTransactionId

string

Transaction ID of Credit Transaction on Destination Card. Example : 147852369

Allowable Values:

0

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "FromCardTransactionId": "2153603722",
    "ToCardTransactionId": "2153603706"
  }
}

CardUnload

Action: POST

Endpoint: /api/CardUnload

POST /api/CardUnload

Use this API to unload funds from a card account balance. Funds are unloaded when debit adjustments needs to be done either while closing account or at any other instance.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

TransactionAmount

decimal

Mandatory

Transaction Amount to be posted Valid value 0-9 Example: 300, 3.5 Condition: Not considered for the multi wallet products.

UniqueTransactionID

string

Optional

Unique Number entered for Transaction which is used in duplicacy check Example:AAA123456789

Allowable Values:

12

BranchCode

string

Optional

Branch code from where the card was issued. Valid Values:0-9 Example:1006

Allowable Values:

20

NotesReason

string

Optional

PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

50

Notes

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

396

WalletUnloadDetails

array

Optional

Sample Request Body 
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "",
  "ProxyNumber": "1314932",
  "TransactionAmount": 2.0,
  "UniqueTransactionID": "",
  "BranchCode": "",
  "NotesReason": "10",
  "Notes": "Card  Resent: Mailed to Different Address",
  "WalletUnloadDetails": [
    {
      "WalletID": 89456,
      "WalletUnloadAmount": 20.0
    }
  ]
}
Response Fields Detail
Fields Description

ReceiptID

string

Receipt ID of a transaction

Allowable Values:

19

TransactionID

string

Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369

Allowable Values:

19

AvailableBalance

decimal

Available balance on the account Valid values : 0-9 Example: 100.50

WalletUnloadDetails

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "ReceiptID": "",
    "TransactionID": "2153609837",
    "AvailableBalance": 2.0,
    "WalletUnloadDetails": [
      {
        "WalletID": 345627,
        "WalletUnloadTransactionID": ""
      }
    ]
  }
}

GetBankDetails

Action: POST

Endpoint: /api/GetBankDetails

POST /api/GetBankDetails

Use this API to Get or update or Validate external Bank account details mapped on account.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

RecipientName

string

Conditional

First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick Condition: Mandatory when DecisionFlag =1.

Allowable Values:

50

BankAccountNumber

string

Conditional

Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678 Condition: Mandatory when DecisionFlag =1

Allowable Values:

17

ConfirmBankAccountNumber

string

Conditional

Re-enter Cardholder's Bank Account Number for confirmation Valid Values:0-9 Example: 1122345678 Condition: Mandatory when DecisionFlag =1

Allowable Values:

17

RoutingNumber

string

Conditional

Bank Routing Number Valid Values:0-9 Example:0110000015 Condition: Mandatory when DecisionFlag = 1 and 2.

Allowable Values:

9

ConfirmRoutingNumber

string

Conditional

Re-enter Bank Routing Number for confirmation Valid Values:0-9 Example:0110000015 It is Mandatory when DecisionFlag = 1.

Allowable Values:

9

DecisionFlag

string

Mandatory

Used for performing various operations when respective flag values defined below are passed. Valid values: 0 = For showing Direct Deposit info 1 = For Updating Direct Deposit info 2 = For Validation of Routing number and Fetch RecipientName based upon entered card/proxy number.

Allowable Values:

2

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "RecipientName": "Harshal",
  "BankAccountNumber": "60000000027166",
  "ConfirmBankAccountNumber": "60000000027166",
  "RoutingNumber": "061120835",
  "ConfirmRoutingNumber": "061120084",
  "DecisionFlag": "1",
  "ProxyNumber": "1316605",
  "CardNumber": ""
}
Response Fields Detail
Fields Description

RoutingNumber

string

Bank Routing Number Valid Values:0-9 Example:0110000015

Allowable Values:

9

BankAccountNumber

string

Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678

Allowable Values:

100

RecipientName

string

First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick

Allowable Values:

50

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "RoutingNumber": "061120835",
    "BankAccountNumber": "60000000027166",
    "RecipientName": "Harshal"
  }
}

GetBankToCardAccount

Action: POST

Endpoint: /api/GetBankToCardAccount

POST /api/GetBankToCardAccount

Use this API to transfer funds from external bank account to Corecard account only when the status of bank account and card is Active.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

RecipientID

Int64

Mandatory

UniqueID of Recipient. Valid Values:0-9 Example:1234567890

TranactionAmount

decimal

Mandatory

Transaction Amount Valid Values: 0-9 Example:100.11

SameDayACHType

string

Optional

For sending transaction in Same Day ACH file, use this field. Valid values: SD1300 or SD1700 Example: SD1300

Allowable Values:

6

SameDayACHEffDateTime

datetime

Conditional

Effective Date for the Same Day ACH transaction. Format: MM/DD/YYYY HH:MM:SS Condition: If value is provided in SameDayACHType then it will become mandatory else optional.

Sample Request Body 
{
  "APIVersion": "1.5",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316315",
  "RecipientID": 176270,
  "TranactionAmount": 10.0,
  "SameDayACHType": "SD1700",
  "SameDayACHEffDateTime": "2022-02-28T15:45:00"
}
Response Fields Detail
Fields Description

TransactionID

Int64

Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369

FundAvailableDate

datetime

Date when the transferred fund will be available to the beneficiary Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransactionID": 41857659,
    "FundAvailableDate": "2020-12-01T00:00:00"
  }
}

GetFeeWaiverInformation

Action: POST

Endpoint: /api/GetFeeWaiverInformation

POST /api/GetFeeWaiverInformation

Use this API to retrieve the Fee waiver count of ATM Withdrawal fee for a card account in context.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1322050"
}
Response Fields Detail
Fields Description

FeeWaiver

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "FeeWaiver": [
      {
        "FeeName": "NewLoadFee",
        "NumberofFeeWaiver": 1.0
      }
    ]
  }
}

GetHoldTransactionDetail

Action: POST

Endpoint: /api/GetHoldTransactionDetail

POST /api/GetHoldTransactionDetail

Use this API to retrieve the hold transactions and related hold placed on different wallets/saving pockets as applicable.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

11

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 etc. Condition:t least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

TransactionID

string

Mandatory

This tag indicates transaction id of pre-authorization transaction. Valid values:0-9 Example:1627876 etc.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "AccountNumber": "60000000032679",
  "CardNumber": "4000000000002345",
  "ProxyNumber": "1316758",
  "TransactionID": "2154381871"
}
Response Fields Detail
Fields Description

TransactionDetails

array

TotalHoldAmount

decimal

This tag indicates total amount to be hold. Example:500.30 etc

TotalHoldAmountCurrencyCodeAlphabetic

string

This tag indicates Currency Name on which transaction is performed. Example:USD etc.

TotalHoldAmountCurrencyCodeNumeric

string

This tag indicates Currency Code on which transaction is performed. Example:026 etc.

SweepTransactionDetails

array

TotalAmount

decimal

This tag indicates Total Sweeped Amount. Example:600.30 etc

TotalAmountCurrencyCodeAlphabetic

string

This tag indicates Currency Name on which sweeping is performed. Example:USD etc.

TotalAmountCurrencyCodeNumeric

string

This tag indicates Currency Code on which sweeping is performed. Example:026 etc.

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransactionDetails": [
      {
        "TransactionDescription": "Purchase",
        "LogicModule": null,
        "CurrencyCodeAlphabetic": "USD",
        "CurrencyCodeNumeric": "840",
        "TransactionAmount": 15.0
      }
    ],
    "TotalHoldAmount": 15.0,
    "TotalHoldAmountCurrencyCodeAlphabetic": "USD",
    "TotalHoldAmountCurrencyCodeNumeric": "840",
    "SweepTransactionDetails": [
      {
        "Description": "Qualifying Wallet",
        "SourceWalletID": "1125",
        "SourceWalletName": "MCC New",
        "SourceWalletCurrencyCodeAlphabetic": "USD",
        "SourceWalletCurrencyCodeNumeric": "840",
        "SourceAmount": 40.0,
        "DestinationWalletID": "1125",
        "DestinationWalletName": "MCC New",
        "DestinationWalletCurrencyCodeAlphabetic": "USD",
        "DestinationWalletCurrencyCodeNumeric": "840",
        "DestinationAmount": 40.0,
        "PostingWallet": "Yes"
      }
    ],
    "TotalAmount": 15.0,
    "TotalAmountCurrencyCodeAlphabetic": "USD",
    "TotalAmountCurrencyCodeNumeric": "840"
  }
}

GetLinkedTransactionDetails

Action: POST

Endpoint: /api/GetLinkedTransactionDetails

POST /api/GetLinkedTransactionDetails

Use this API to fetch details of the linked transactions which were posted due to the posting wallet is different than the healthcare amount deducted wallet.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

TransactionID

string

Mandatory

This tag indicates transaction id of any transaction. Valid values:0-9 Example:1627876 etc.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "TransactionID": "2154381871"
}
Response Fields Detail
Fields Description

LinkedTransactionDetails

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "LinkedTransactionDetails": [
      {
        "TransactionID": "12365485",
        "WalletorSavingPocketName": "MCC Wallet",
        "Amount": 10.01,
        "PostingWallet": "Yes"
      }
    ]
  }
}

GetTransactionHistory

Action: POST

Endpoint: /api/GetTransactionHistory

POST /api/GetTransactionHistory

Use this API to fetch monetary transaction posted on a card account. Combination of multiple filters such as date range, Transaction ID, Minimum Transaction Amount, Maximum Transaction Amount and Transaction type are present to fetch records of all transactions, settled transactions, outstanding transactions, expired transactions.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

BatchSize

Int32

Optional

Number of records to be returned in a page Valid Values: 0-9 Example:100,50 will return 100 or 50 transactions at once.

PageIndex

Int32

Optional

Page Number Valid Values: 0-9 Example: 0,1,2

TransactionId

string

Optional

Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369

Allowable Values:

19

FromDate

string

Conditional

To set transactions boundary 'From Date' Format : YYYY-MM-DD HH:mm:ss Valid Values:0-9 Example : 2015-12-11 00:00:00 Condition:Required only when ToDate is passed in Input

ToDate

string

Conditional

To set transactions boundary 'To Date' Format : YYYY-MM-DD HH:mm:ss Valid Values:0-9 Example : 2015-12-11 00:00:00 Condition:Required only when FromDate is passed in Input.

MinimumTransactionAmount

string

Optional

Transactions can be searched by Transaction amount greater or equal to Minimum Transaction Amount. Format: XXX.XX Example: 25.00

MaximumTransactionAmount

string

Optional

Transactions can be searched by Transaction amount less than or equal to Maximum Transaction Amount. Format: XXX.XX Example: 25.00

TransactionHistoryType

string

Optional

Type of Transaction’s History. Valid Values: 0 or Null = All Transactions 1 = Settled Transactions 2 = Outstanding Transactions 3 = Expired Transactions 5 = Post Credit Transaction 6 = Saving Transaction Example: 1

Allowable Values:

2

WalletID

Int32

Optional

Wallet ID of wallet mapped on account Valid values:0-9 Example:1005
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000031689",
  "CardNumber": "",
  "ProxyNumber": "",
  "BatchSize": 100,
  "PageIndex": 0,
  "TransactionId": "",
  "FromDate": "",
  "ToDate": "",
  "MinimumTransactionAmount": "",
  "MaximumTransactionAmount": "",
  "TransactionHistoryType": "",
  "WalletID": 0
}
Response Fields Detail
Fields Description

AvailableBalance

decimal

Available balance on the account. Valid values : 0-9 Example: 100.50 Note: In case of the non wallet product, tag will return the account available balance whereas in case of the multi wallet product, tag will return wallet available balance.

CurrentBalance

decimal

This tag indicates the current balance of the account. Condition: In case of the non wallet product, tag will return the account current balance whereas in case of the multi wallet product, tag will return wallet current balance.

LastTransactionDate

datetime

Date of Last transaction posted on account Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

LastCreditDate

datetime

Last Credit Date of Account/Card. Format: YYYY-MM-DDTHH:mm:ss Example: 2015-12-11T13:05:10

LastCreditAmount

decimal

Last Credited Amount in the card Valid Values: 0-9 Format: XXX.XX Example: 150.00

DisputeAmount

decimal

Disputed amount on the card Example : 100

TransactionHistoryList

array

Sample Response Body 

{
  "Message": "Processed Successfully.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AvailableBalance": 163.01,
    "CurrentBalance": -152.01,
    "LastTransactionDate": "2020-05-17T00:00:00",
    "LastCreditDate": "2020-10-18T00:00:00",
    "LastCreditAmount": 11.23,
    "DisputeAmount": 10.23,
    "TransactionHistoryList": [
      {
        "PostingReference": "Transaction posted successfully",
        "TransactionSource": "CoreMoney",
        "TransactionDescription": "37 - LOAD",
        "CurrentBalance": -152.01,
        "CardAcceptorNameLocation": "",
        "TransactionReason": "",
        "OverLimitFlag": "N",
        "DeclineIndicator": "NO",
        "MerchantCity": "",
        "Comment": "",
        "TransactionType": "Settled",
        "CardNumber4Digits": "2785",
        "ProductBin": "406684",
        "CardNumber": "406684******2785",
        "CustomAccountID": "",
        "WalletID": 0,
        "WalletName": "",
        "ThreeDS": "Non-Secure",
        "AvailableBalance": 163.01,
        "AccountNumber": "60000000031689",
        "ProxyNumber": "1316608",
        "TransactionId": 2153561714,
        "TransactionDateTime": "2020-05-17T00:00:00",
        "PostTime": "2020-08-02T00:00:00",
        "TransactionAmount": 152.01
      }
    ]
  }
}

GetTransferActivity

Action: POST

Endpoint: /api/GetTransferActivity

POST /api/GetTransferActivity

Use this API to fetch Bank to Card and Card to Bank category transaction posted on a card account.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/Proxy Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Account Number/Proxy Number is required.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000011558",
  "ProxyNumber": ""
}
Response Fields Detail
Fields Description

TransferActivitiesData

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransferActivitiesData": [
      {
        "BankName": "BANK OF AMERICA, N.A.",
        "AccountNumber": "3216120006506",
        "UserId": "Cardholder",
        "TransactionStatus": "In Process",
        "TransferType": "B2C",
        "TranactionAmount": 10.1,
        "CreatedDate": "2020-02-10T00:00:00",
        "FundAvailableDate": "2020-05-17T00:00:00"
      }
    ]
  }
}

IntraWalletOrSavingPocketTransfer

Action: POST

Endpoint: /api/IntraWalletOrSavingPocketTransfer

POST /api/IntraWalletOrSavingPocketTransfer

Use this API to transfer amounts within the wallets/saving pockets.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1617358 etc. Condition:t least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

SourceWalletID

Int32

Mandatory

This tag indicates Source Wallet ID of wallet mapped on account Valid values:0-9 Example:1005 etc.

Allowable Values:

10

DestinationWalletID

Int32

Mandatory

This tag indicates Destination Wallet ID of wallet mapped on account Valid values:0-9 Example:1006 etc.

Allowable Values:

10

TransferAmount

decimal

Mandatory

This tag indicates amount which is going to be transfer from Source Wallet to Destination Wallet. Example 100.00,200.00 etc.

Allowable Values:

11

Notes

string

Optional

Description of the notes entered by the user. Valid Values : A-Z,0-9 Example : Please enter a value

Allowable Values:

500

NotesReason

string

Optional

Description: Predefined Memo Reasons. Valid Value: Please refer appendix Section 'Memo Reason'

Allowable Values:

50
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.70",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "",
  "RequestDate": "",
  "AccountNumber": "60000000032679",
  "CardNumber": "4000000000002345",
  "ProxyNumber": "1316758",
  "SourceWalletID": 1007,
  "DestinationWalletID": 1008,
  "TransferAmount": 50.0,
  "Notes": "Cardholder called in to dispute a transaction. Warm transferred.",
  "NotesReason": "2"
}
Response Fields Detail
Fields Description

TransferDebitTransactionID

string

This tag indicates transaction ID of the transaction posted on the source wallet Example 876789 etc.

TransferCreditTransactionID

string

This tag indicates transaction of the transaction posted on the destination wallet Example 876790 etc.

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransferDebitTransactionID": "2154479725",
    "TransferCreditTransactionID": "2154479733"
  }
}

SavingAccountsFundsTransfer

Action: POST

Endpoint: /api/SavingAccountsFundsTransfer

POST /api/SavingAccountsFundsTransfer

Use this API to transfer funds from prepaid card account to its saving account and vice a versa. User should provide either prepaid card account or saving account information. System fetches its counterparts account information and funds will be transferred.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

TransferType

string

Mandatory

Type of money transfer. Valid values: 0 = From Prepaid Account to Saving Account 1= From Saving Account To prepaid Account Example: 0 Condition : with 0 , At least one of Card Number/ProxyNumber/Account Number is required with 1 , Only Saving Account Number is required.

Allowable Values:

1

TransactionAmount

decimal

Mandatory

Transaction Amount to be posted Valid value 0-9 Example: 300, 3.5
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1311037",
  "AccountNumber": "",
  "TransferType": "0",
  "TransactionAmount": 2.0
}
Response Fields Detail
Fields Description

PrepaidAccountBalance

decimal

Balance of Prepaid Account Example: 55.56

SavingAccountBalance

decimal

Balance of Saving Account Example: 87.56

DebitTransactionID

string

ID of Debit Transaction Example: 9876543210

Allowable Values:

19

CreditTransactionID

string

ID of Credit Transaction Example: 9876543211

Allowable Values:

19

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "PrepaidAccountBalance": 43.33,
    "SavingAccountBalance": 23.05,
    "DebitTransactionID": "2153643866",
    "CreditTransactionID": "2153643892"
  }
}

TransactionHistory

Action: POST

Endpoint: /api/TransactionHistory

POST /api/TransactionHistory

Use this API to fetch monetary transaction posted on a card account. Combination of multiple filters such as date range, Transaction ID, Minimum Transaction Amount, Maximum Transaction Amount and Transaction type are present to fetch records of all transactions, settled transactions, outstanding transactions, expired transactions.

Request Fields Detail
Fields Description

AccountNumber

string

Optional

Account Number of card Example:3002151478 Application Version is 1.3 Condition:At least Account Number / Card Number/ Proxy Number is required.

Allowable Values:

19

ClientID

string

Optional

Client ID Example: 1000

Allowable Values:

0

ClientPassword

string

Optional

Client Password Example: *********

Allowable Values:

0

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Card Number of card Example:134567****1200 Application Version is 1.3 Condition:At least Card Number/ Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of card Example: 10501001744174117 Valid values :0-19 Condition : At least Card Number/ Proxy Number is required.

Allowable Values:

19

NumberOfDays

string

Optional

NumberOfDays

Allowable Values:

3

NumberOfTransactions

string

Optional

Number of Transactions Example: 5/10

Allowable Values:

4

FromDate

string

Optional

Transactions can be searched by Transaction Date" Example:20170528 Format :YYYYMMDD FromDate

Allowable Values:

20

ToDate

string

Optional

Transactions can be searched by Transaction Date Example:20170528 Format :YYYYMMDD Required when ToDate is passed in Input.

Allowable Values:

20

TransferAmountFrom

string

Optional

Transactions can be searched by Transaction amount greater or equal to Min Transaction Amount Example: 25.00

Allowable Values:

30

TransferAmountTo

string

Optional

Transactions can be searched by Transaction amount less than or equal to Max Transaction Amount Example: 250.00

Allowable Values:

30

NumberOfSavingAcctTransactions

string

Optional

NumberOfSavingAcctTransactions

Allowable Values:

4

PageIndex

string

Optional

Start Count of Transactions Example: 0,1,100

Allowable Values:

4

AllFlag

string

Optional

All Flag Example: 0 = No 1 = Yes

Allowable Values:

5

LocationID

string

Optional

Location ID Example: 1

Allowable Values:

9
Sample Request Body 
{
  "AccountNumber": "60000000031689",
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316608",
  "NumberOfDays": "",
  "NumberOfTransactions": "",
  "FromDate": "",
  "ToDate": "",
  "TransferAmountFrom": "",
  "TransferAmountTo": "",
  "NumberOfSavingAcctTransactions": "",
  "PageIndex": "100",
  "AllFlag": "1",
  "LocationID": ""
}
Response Fields Detail
Fields Description

WarehousedTxns

array

CHWarehousedTxns

FeeDetail

array

FeeDetail

TransactionList

array

List of Transactions

SavingAccountTransactions

array

List of Transactions that are carried our over the savings Account

LinkedCardInformations

array

LinkedCardInformations

LastTransaction

string

Last Transaction Application Version is 1.3

BeginningBalance

decimal

Beginning Balance of account after respective transaction Example: 250.00

EndingBalance

decimal

Ending Balance of account after respective transaction Example: 250.00

TotalCredits

decimal

Total Credits of the account

TotalDebits

decimal

Total Debits of the account

TotalFees

decimal

Total Fees of the account Example : 20.00

TransactionDate

datetime

Transaction Date of the Transaction Example: 06/29/2017 Format : MM/DD/YYYY

CurrentCardBalance

decimal

Current Card Balance Application Version is 1.3

ExpirationDate

datetime

Expiration date of card Example: 05/31/2021

AllFlag

string

AllFlag

StartCount

string

Start Count Application Version is 1.3

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "WarehousedTxns": [
      {
        "TransactionID": "2153561714",
        "TransactionDateTime": "2018-09-21T00:00:00",
        "TransactionDescription": "LOAD",
        "TransactionAmount": 125.01,
        "EffectiveDateTime": "2020-12-01T00:00:00"
      }
    ],
    "FeeDetail": [
      {
        "FeeName": "",
        "TotalFeeForPeriod": 0.0,
        "TotalFeeForYear": 0.0
      }
    ],
    "TransactionList": [
      {
        "TransactionDate": "2020-11-08T00:00:00",
        "TransactionTime": "",
        "TransactionAmount": 125.01,
        "TransactionStatus": "1",
        "TransactionType": "Settled",
        "TransactionMCC": "",
        "Description1": "",
        "Description2": "",
        "Description3": "",
        "Description4": "",
        "TransactionNumber": "",
        "TransactionLifeCycleUniqueID": "",
        "MerchantID": "",
        "MerchantName": "",
        "MerchantCity": "",
        "MerchantState": "",
        "MerchantType": "",
        "DrCrIndicator": "NO",
        "SpendCategory": "Miscellaneous",
        "AuthTranID": "",
        "CardAcceptorNameLocation": "",
        "OverLimitFlag": "",
        "CurrentBalance": -152.01,
        "PostedDate": "2020-12-01T00:00:00",
        "PostedTime": "",
        "NoteReason": "",
        "Notes": "",
        "IsDeclined": "NO",
        "CardNumber": "406684******2785",
        "DisputeStatus": "",
        "IsDisputeAllowed": "NO",
        "DisputeStatusUpdateTime": "",
        "AvailableBalance": 152.01
      }
    ],
    "SavingAccountTransactions": [
      {
        "TransactionDate": "2020-11-08T00:00:00",
        "TransactionTime": "",
        "TransactionAmount": 125.01,
        "TransactionStatus": "1",
        "TransactionType": "Settled",
        "TransactionMCC": "",
        "Description1": "",
        "Description2": "",
        "Description3": "",
        "Description4": "",
        "TransactionNumber": "",
        "TransactionLifeCycleUniqueID": "",
        "MerchantID": "",
        "MerchantName": "",
        "MerchantCity": "",
        "MerchantState": "",
        "MerchantType": "",
        "DrCrIndicator": "NO",
        "SpendCategory": "Miscellaneous",
        "AuthTranID": "",
        "CardAcceptorNameLocation": "",
        "OverLimitFlag": "",
        "CurrentBalance": -152.01,
        "PostedDate": "2020-12-01T00:00:00",
        "PostedTime": "",
        "NoteReason": "",
        "Notes": "",
        "IsDeclined": "NO",
        "CardNumber": "406684******2785",
        "DisputeStatus": "",
        "IsDisputeAllowed": "NO",
        "DisputeStatusUpdateTime": "",
        "AvailableBalance": 152.01
      }
    ],
    "LinkedCardInformations": [
      {
        "CardNumber": "406681******2773",
        "CreatedOn": "2019-09-08T00:00:00",
        "CardExpiryDate": "2026-11-08T00:00:00",
        "ManualCardStatus": "2",
        "CardType": "",
        "ProxyNumber": "1316646"
      },
      {
        "CardNumber": "406684******4195",
        "CreatedOn": "2019-09-08T00:00:00",
        "CardExpiryDate": "2024-08-03T00:00:00",
        "ManualCardStatus": "9",
        "CardType": "",
        "ProxyNumber": "1317775"
      }
    ],
    "LastTransaction": "",
    "TotalCredits": 11.01,
    "TransactionDate": "2019-09-08T00:00:00",
    "CurrentCardBalance": -152.01,
    "ExpirationDate": "2026-11-08T00:00:00",
    "AllFlag": "",
    "StartCount": ""
  }
}

ValidateBankAccount

Action: POST

Endpoint: /api/ValidateBankAccount

POST /api/ValidateBankAccount

Use this API to validate B2C recipient.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

RecipientId

Int64

Mandatory

UniqueID of Recipient. Valid Values:0-9 Example:1234567890

MicroDepositAmount1

decimal

Mandatory

Micro Deposit Amount 1. It validates Micro deposit transaction while adding any bank account. Valid Values: 0.1-0.99 Example: 0.50

MicroDepositAmount2

decimal

Mandatory

Micro Deposit Amount 2. It validates Micro deposit transaction while adding any bank account. Valid Values: 0.1-0.99 Example: 0.50
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "RecipientId": 176289,
  "MicroDepositAmount1": 0.08,
  "MicroDepositAmount2": 0.19
}
Response Fields Detail
Fields Description

ExternalBankStatus

string

External Bank Status.

ValidationTriesCount

string

This is the count how many times validation of bank account was attempted.

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "ExternalBankStatus": "Validated",
    "ValidationTriesCount": ""
  }
}

ValidateCard

Action: POST

Endpoint: /api/ValidateCard

POST /api/ValidateCard

Use this API to validate the recipient card for Card to card Transfer operation.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

ReciepientCardNumber

string

Conditional

Card Number of receipient. Valid values: 0-9 Clear Card Number Example: *********4567[For Compliance masked BIN and Extended BIN] Condition : At least one of Recipient Card Number/Recipient Proxy Number is required.

Allowable Values:

16

ReciepientProxyNumber

string

Conditional

Proxy Number of receipient Valid Values:0-9 Example: 1001741741741 Condition : At least one of Recipient Card Number/Recipient Proxy Number is required.

Allowable Values:

19
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ReciepientCardNumber": "",
  "ReciepientProxyNumber": "1311037"
}
Response Fields Detail
Fields Description

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}