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 Insurance Product
Status:
Production
Version:
V2
Category:
Card Services
Card Insurance Product
Overview
Card insurance enquiry provides access real-time information about insurance details for a specific card. This API allows businesses, developers, or other entities to programmatically retrieve insurances program details, which can be utilized for various purposes such as showing the available insurance programs, and the related status.
This API simplifies the process of accessing insurance information programmatically, such as:
Insurance Name
The designated title of the insurance program associated with the cardholder's account.
Insurance Status
Current enrollment condition of the cardholder within the specified insurance program.
Insurance Activation Date
The calendar date when the cardholder's insurance coverage officially commenced.
Insurance Company
The financial institution or organization providing the insurance coverage for the card program.
How It Works
The Card insurance enquiry API sends the card identifier which returns all available insurance programs in the response. This will give you the option to list the insurance programs plus getting the related parameters like fee, grace period.
Card Insurance Product
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_insurance_product | 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_INSURANCE_PRODUCT" | |||||||
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 Id | ||||||
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_card_insurance_product": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_CARD_INSURANCE_PRODUCT",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"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_insurance_product | 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 "REP_CARD_INSURANCE_PRODUCT" | |||||||
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 resopnse - 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 | card_identifier_id | string | 32 | Card identifier id | ||||||
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 | |||||||
insurance_products | name | string | 255 | Name of the insurance (E.g. Credit Shield) | ||||||
code | string | 2 | Code of the insurance - From 01 to 12 | |||||||
is_active | string | 32 | Business Reference of Status (CANCELLED|ACTIVE) | |||||||
status_code | string | 10 | Status Code of the insurance (F,R,U,etc.) | |||||||
status_name | string | 255 | Status name (Enrolled, Cancelled by User, etc.) | |||||||
activation_date | string | 10 | Activation Date | |||||||
deactivation_date | string | 10 | Deactivation Date | |||||||
reinstatement_date | string | 10 | Reinstatement Date | |||||||
parameters | insurance_company | string | 2 | Insurance company code | ||||||
grace_period_duration | string | 2 | Duration of grace period | |||||||
grace_period_type | string | 2 | Type of grace period | |||||||
dlq_cancel_auto_reinstate | string | 2 | Number of auto-reinstatements after delay | |||||||
dlq_cancel_man_reinstate | string | 2 | Number of manual reinstatements after delay | |||||||
allow_zero_coverage | string | 1 | Allow zero coverage | |||||||
max_coverage_behavior | string | 1 | Max coverage behavior | |||||||
minimum_fee | string | 10 | Minimum fee | |||||||
base_fee | string | 10 | Base fee | |||||||
percentage | string | 5 | Percentage | |||||||
max_coverage | string | 10 | Maximum coverage | |||||||
max_age | string | 3 | Maximum age for coverage |
{
"NISrvResponse": {
"response_card_insurance_product": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_CARD_INSURANCE_PRODUCT",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T06:49:02.366Z",
"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": "99984100111514120000",
"card_identifier_type": "EXID",
"insurance_products": [
{
"name": "Credit Shield",
"code": "01",
"is_active": "CANCELLED",
"status_code": "R",
"status_name": "Canceled at the request of the insured party",
"activation_date": "",
"deactivation_date": "",
"reinstatement_date": "",
"parameters": [
{
"insurance_company": "CS",
"grace_period_duration": "1",
"grace_period_type": "M",
"dlq_cancel_auto_reinstate": "3",
"dlq_cancel_man_reinstate": "4",
"allow_zero_coverage": "N",
"max_coverage_behavior": "A",
"minimum_fee": "5",
"base_fee": "0",
"percentage": "1",
"max_coverage": "7000",
"max_age": "51"
}
]
}
]
}
}
}
}
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.