Card Services
Overview
Our card services support multiple card types, including Visa, MasterCard, American Express, and Discover, as well as other popular payment methods like Apple Pay and Google Pay. You can also set up recurring payments for your customers, making it easy for them to make regular payments without having to enter their card information every time.Our advanced fraud detection and prevention features use machine learning algorithms to help identify and prevent fraudulent transactions. We also provide detailed reporting and analytics, allowing you to track and analyze payment data and make data-driven decisions.
We also offer multi-currency support, which allows you to accept payments from customers in different parts of the world. And with our 24/7 customer support, you can always count on us to help you resolve any issues related to our card services.Our card services are also fully compliant with all local and international regulations, such as PCI DSS, so you can be confident that you're accepting payments in a secure and compliant manner.
Card Replacement (Post)
This webbook serves to promptly inform your system whenever a card replacement occurs. This helps ensure that important card management activities are communicated accurately and on time. Card replacements are crucial in banking because they affect customer accounts, security, and transaction abilities.
Pin Action (Post)
This webbook serves to promptly inform your system whenever there are PIN-related actions performed on a card. It's important for maintaining card security, overseeing operations, and meeting regulatory requirements in finance. PIN-related actions, as of now we support reset pin counter only.
Card Balance Enquiry
Status:
Production
Version:
V2
Category:
Card Services
Card Balance Enquiry
Overview
This API, designed to retrieve balances for a specified card, retrieves information such as the available amount, blocked or memo amount, due amount, and overdue amount. It should be noted that this API can only be utilized when the balances are stored in Network International's systems. It is not applicable for debit cards or prepaid cards with external store of value or wallets.
Real-time balance information
The Card Balance Enquiry API provides real-time balance information, allowing financial institutions to access the most up-to-date information about a card's available funds and other types of balances.
Multiple balance types
The API allows financial institutions to retrieve different types of balance information such as Amount Available, Blocked/Memo Amount, Due Amount, Overdue Amount and other types of balances.
Easy integration
The API is designed to be easy to integrate into existing systems and applications, allowing developers to quickly and easily access balance information for a specific card, without the need for extensive development work.
How It Works
This API is used to retrieve balance information for a specific card. When called, the API will return details on the available amount, blocked or memo amount, due amount, and overdue amount associated with the card. It should be noted that in order for this API to work, the balance information for the card must be stored in the systems of Network International.
This means that the API will not work for debit cards or prepaid cards that have an external store of value or are linked to a digital wallet. The API will take the card number as an input and return the balance information in a JSON format. This information can then be used to help businesses or financial institutions keep track of their customers' card usage and financial status.
Wallets object in the response is only applicable for multi-currency product, in which the list of wallets will be part of the response.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
Card Balance Enquiry
Status:
Production
Version:
V2
Category:
Card Services
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_card_balance_enquiry | 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 | Message functions: Should be “REQ_CARD_BALANCE_ENQUIRY” | |||||||
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 | |||||||
card_expiry_date | string | 4 | Expiry Format YYMM | |||||||
balance_list | string | 512 | List of required balance types. Example AVAILABLE,BLOCKED |
{
"NISrvRequest": {
"request_card_balance_enquiry": {
"header": {
"msg_id": "7t88277687",
"msg_type": "ENQUIRY",
"msg_function": "REQ_CARD_BALANCE_ENQUIRY",
"src_application": "BNK",
"target_application": "WAY4",
"timestamp": "7t88277687",
"bank_id": "NIC"
},
"body": {
"card_identifier_id": "99984100111514120378",
"card_identifier_type": "EXID"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_card_balance_enquiry | header | msg_id | string | 12 | Unique Source Message ID eg ada123456fdsf | ||||
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 | Default RES_CARD_BALANCE_ENQUIRY | |||||||
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 | 15 | Timestamp of the response - 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” | |||||||
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 | customer_id | string | 20 | Customer ID: Customer Identification number This should be a unique number | ||||||
institution_id | string | 5 | institution id is the code that is created for each bank or FI(it is the same value as bank code), 982 value is just used as an example in Sandbox | |||||||
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 | |||||||
card_expiry_date | string | 4 | YYMM Ex: 2310 | |||||||
cardholder_name | string | 21 | Cardholder Name | |||||||
account_number | string | 64 | Account number | |||||||
balances | type | string | 32 | Type of the balance | ||||||
currency | string | 3 | Currency | |||||||
amount | string | 20 | Balance ammount | |||||||
wallets | wallet_identifier_id | string | 64 | Wallet Account Number | ||||||
wallet_identifier_type | string | 15 | Wallet Identifier Type | |||||||
currency | string | 3 | Wallet Currency | |||||||
priority | string | 3 | Wallet priority | |||||||
role | string | 3 | Wallet Role | |||||||
balances | type | string | 32 | Balance type | ||||||
currency | string | 5 | Currency | |||||||
amount | string | 20 | Balance Amount |
{
"NISrvResponse": {
"response_card_balance_enquiry": {
"header": {
"msg_id": "1710844286",
"msg_type": "ENQUIRY",
"msg_function": "REP_CARD_BALANCE_ENQUIRY",
"src_application": "BNK",
"target_application": "WAY4",
"timestamp": "2024-03-19T14:31:26.21+04:00",
"bank_id": "NIC"
},
"exception_details": {
"application_name": "TCC-ADP",
"date_time": "2024-03-19T14:31:26.21+04:00",
"status": "S",
"error_code": "000",
"error_description": "Success"
},
"body": {
"customer_id": "100000027",
"institution_id": "982",
"card_identifier_id": "99984100111514120378",
"card_identifier_type": "EXID",
"card_expiry_date": "3001",
"cardholder_name": "JOHN DOE",
"account_number": "0009821110000000049",
"balances": [
{
"type": "DUE",
"currency": "AED",
"amount": "0.00"
},
{
"type": "PAST_DUE",
"currency": "AED",
"amount": "0.00"
},
{
"type": "TOTAL_DUE",
"currency": "AED",
"amount": "0.00"
},
{
"type": "BAL_INST",
"currency": "AED",
"amount": "0.00"
},
{
"type": "AVAILABLE",
"currency": "AED",
"amount": "55000.00"
},
{
"type": "BLOCKED",
"currency": "AED",
"amount": "0.00"
},
{
"type": "TOTAL_BALANCE",
"currency": "AED",
"amount": "0.00"
},
{
"type": "IPP_RET-LOAN-UNB",
"currency": "AED",
"amount": "0.00"
},
{
"type": "DIRECT_DEBIT",
"currency": "AED",
"amount": "0.00"
},
{
"type": "REPAYABLE",
"currency": "AED",
"amount": "0.00"
},
{
"type": "AVAILABLE_CASH",
"currency": "AED",
"amount": "33000.00"
},
{
"type": "PAYMENT",
"currency": "AED",
"amount": "0.00"
}
]
}
}
}
}
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 |
How It Works
Follow the steps below. For more details, read the Quick Start Guide.
1- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
2- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
3- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
4- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.
5- Process 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.