Load
Before using a prepaid card, the card has to be loaded with money. It’s a credit transaction that initiates the (available) balance of the account. The load can be received via multiple channels like ACH, Payment Gateway, APIs, Branch. Load Transaction is verified against the card limit. Also, different load fees can be charged based on the channels used to load a card account.
CardLoad
Action: POST
Endpoint: /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 |
|
AdvanceCollectInstallment string Optional |
Display number of installment opted by cardholder to repay Advance taken Valid Values: Blank( No installment ), 4, 8 and 12 Example: 4 Allowable Values: 2 |
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 } ], "AdvanceCollectInstallment": "4" }
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": "" } ] } }