Prepaid Solutions
Overview
With our prepaid solution, you can extend prepaid products to customers without constraints such as credit rating, income, or bank account ownership. The solution includes issuer, branch, corporate, or cardholder web-based portals, enabling effortless sales, maintenance, load, and card or customer lifecycle management. These features empower non-banked customers to manage their finances like seasoned professionals, making financial management more accessible and straightforward.
Activate prepaid cards
Users can activate prepaid cards when they are first issued or after they have been deactivated for any reason.
Check card balances
Users can check the balance on a prepaid card in real-time or on a scheduled basis.
View transaction history
Users can view a detailed record of all transactions made with a prepaid card, including the date, time, amount, and location of each transaction.
Reload cards
Users can add funds to a prepaid card, either by transferring money from another account or by purchasing a reload card.
Resolve disputes
Users can access a process for resolving disputes or issues that may arise with prepaid card transactions.
Manage card accounts
Users can view and manage their prepaid card accounts, including the ability to set spending limits, view transaction history, and update personal information.
Get Flat BT
Status:
Production
Version:
V2
Product:
Prepaid Solutions
Get Flat BT
Overview
This API, designed to retrieve Flat balances for a specified card. It should be noted that this API can only be utilized when the balances are stored in Network Internationals systems. It is not applicable for debit cards or prepaid cards with external store of value or wallets.
Status:
Production
Version:
V2
Product:
Prepaid Solutions
| Node | Child Node | Type | Length | Description |
|---|---|---|---|---|
| Authorization | Bearer xxxx | string | Authorization Header (Bearer Token) | |
| Content-Type | application/json | string | Content Type |
| Node Type | Type | Length | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| NISrvRequest | request_flat_bt | header | msg_id | string | 12 | Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID” | ||||
| msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
| msg_function | string | 50 | Static Value - REQ_FLAT_BT | |||||||
| src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
| target_application | string | 10 | The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call | |||||||
| timestamp | string | 30 | Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
| bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
| body | card_identifier_id | string | 32 | card identifier | ||||||
| card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | |||||||
{
"NISrvRequest": {
"request_flat_bt": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_FLAT_BT",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"body": {
"card_identifier_id": "454545XXXXXX1234",
"card_identifier_type": "EXID"
}
}
}
}
| Node | Child Node | Type | Length | Description | |
|---|---|---|---|---|---|
| Content-Type | application/json | string | Content Type | ||
| Node Type | Type | Length | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| NISrvResponse | response_flat_bt | header | msg_id | string | 12 | Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID” | ||||
| msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
| msg_function | string | 50 | Static Value - REP_FLAT_BT | |||||||
| src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
| target_application | string | 10 | The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call | |||||||
| timestamp | string | 30 | Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS | |||||||
| bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
| exception_details | application_name | string | 20 | Application Name | ||||||
| date_time | string | 30 | Timestamp of the response Format “YYYY-MM-DD HH:MM:SS” | |||||||
| status | string | 1 | Status of the request (S/F) | |||||||
| error_code | string | 4 | EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
| error_description | string | 100 | Error Description (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
| transaction_ref_id | string | 20 | The tracking_id sent in the request will be sent back in response in this field. | |||||||
| body | card_identifier_id | string | 32 | 454545XXXXXX1234 | ||||||
| card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | |||||||
| flat_bt_plans | plan_number | string | 5 | Plan number | ||||||
| plan_type | string | 32 | Plan type | |||||||
| plan_group | string | 32 | Plan Group | |||||||
| payment_credited | string | 32 | Payment credited | |||||||
| outstanding_balance | string | 32 | OTB balance | |||||||
| minimum_amount_due | string | 32 | Minimum due amount | |||||||
| deferred_interest | string | 32 | deferred interest | |||||||
| accrued_interest | string | 32 | Accured interest | |||||||
| perdiem_interest | string | 32 | Per diem interest | |||||||
| plan_open_date | string | 32 | Plan open date | |||||||
{
"NISrvResponse": {
"response_flat_bt": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_FLAT_BT",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"exception_details": {
"application_name": "TCC-ADP",
"date_time": "2023-02-01T16:39:47.314+04:00",
"status": "S",
"error_code": "000",
"error_description": "Success",
"transaction_ref_id": "236001"
},
"body": {
"card_identifier_id": "454545XXXXXX1234",
"card_identifier_type": "CONTRACT_NUMBER\/EXID",
"flat_bt_plans": {
"plan_number": "60006",
"plan_type": "FP",
"plan_group": "FP_BT",
"payment_credited": "0",
"outstanding_balance": "500",
"minimum_amount_due": "0",
"deferred_interest": "0",
"accrued_interest": "0",
"perdiem_interest": "0",
"plan_open_date": "2025-09-11T00:00:00.000Z"
}
}
}
}
}
| Code | Description |
|---|---|
| 200 | Sample Description |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal Server Error |
| 502 | Bad gateway |
| 503 | Scheduled Maintenance |
| 504 | Gateway Timeout |
| 596 | Service Not Found |
| Code | Description | |||||
|---|---|---|---|---|---|---|