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.
Cards List
Status:
Production
Version:
V2
Category:
Card Services
List of Cards
Overview
This API enables financial institutions to retrieve a comprehensive list of all cards associated with a specific cardholder, regardless of the card product type (Prepaid, Credit, or Debit). This API is an essential component of Mobile Banking or Home Banking applications, allowing institutions to input a client ID or account ID and retrieve all associated cards. The API response includes key information such as the masked PAN, expiration date, card product details, and status of each card.
Single API for all card types:
The API provides an overview of all card types across different product types, making it easy to manage and access data for multiple card types in one place.
Dashboard for customer channels or CRM applications:
The API allows for the creation of a landing page dashboard for customer channels or CRM applications, providing a centralized location for cardholders to access and manage their card information.
Use case flexibility:
The API allows for a variety of use cases, such as card activation, block/unblock, and transaction history, giving cardholders the ability to manage their cards in a variety of ways.
How It Works
This API allows for the retrieval of all cards associated with a specific cardholder, using a provided customer identifier. The returned list includes all cards, regardless of their status or expiration date, allowing the consumer of the API to implement their own filtering within their application. If a card has been renewed, expired versions will not be included in the list, but instead the newest version will be retrieved.
Additionally, the API provides a list of statuses for each card, such as account status, card status, and plastic status, which can be used to determine cardholder actions such as activation or blocking/unblocking.
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.
Cards List
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_list_of_cards | 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_LIST_OF_CARDS | |||||||
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 | customer_id | string | 20 | Either customer_id or account_number has to be sent | ||||||
account_number | string | 64 | Account number | |||||||
card_type | string | 20 | Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT |
{
"NISrvRequest": {
"request_list_of_cards": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_LIST_OF_CARDS",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"bank_id": "NIC"
},
"body": {
"customer_id": "100000027",
"account_number": "0009821110000000049",
"card_type": "CREDIT"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_list_of_cards | 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 REP_LIST_OF_CARDS | |||||||
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 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” | |||||||
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 | Either cusomer_id or account_number | ||||||
account_number | string | 64 | Account number | |||||||
cards | 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 | |||||||
contract_name | string | 100 | Contract name | |||||||
masked_pan | string | 16 | Masked PAN | |||||||
rbs_number | string | 64 | RBS is Core banking system number | |||||||
card_display_name | string | 50 | Embossed Name | |||||||
CIF_number | string | 20 | CIF Number | |||||||
card_expiry_date | string | 4 | YYMM Ex 2310 | |||||||
card_role | string | 1 | Card Role Primary/Supplementary | |||||||
account_number | string | 64 | Account number | |||||||
product_code | string | 32 | Product code | |||||||
product_group | string | 32 | Product Group | |||||||
product_short_code | string | 32 | Product short code | |||||||
product_name | string | 32 | Product name | |||||||
card_brand | string | 32 | Card brand | |||||||
card_virtual_indicator | string | 1 | P/V | |||||||
current_pin_attempt | string | 3 | Current pin attempt | |||||||
max_pin_attempt | string | 3 | Max pin attempt | |||||||
set_pin_indicator | string | 3 | Additional flag to identify if PIN set was done | |||||||
statuses | type | string | 10 | Status type | ||||||
value | string | 10 | Status value | |||||||
changed_date | string | 10 | Date of status change | |||||||
description | string | 100 | Brief description | |||||||
contract_role | string | 3 | Role of top contract | |||||||
balances | type | string | 32 | Balance type | ||||||
currency | string | 5 | Currency | |||||||
amount | string | 20 | Balance Amount | |||||||
custom_fields | key | string | 128 | Client type Tag | ||||||
value | string | 128 | Tag value |
{
"NISrvResponse": {
"response_list_of_cards": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_LIST_OF_CARDS",
"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": {
"customer_id": "100000027",
"account_number": "0009821110000000049",
"cards": [
{
"card_identifier_id": "99984100130233802017",
"card_identifier_type": "EXID",
"contract_name": "999841XXXXXX3382",
"masked_pan": "999841XXXXXX3382",
"rbs_number": "123456789",
"card_display_name": "JOHN DOE",
"CIF_number": "100000027",
"card_expiry_date": "3001",
"card_role": "P",
"account_number": "0009821110000000049",
"product_code": "982_AED_002_P",
"product_group": "",
"product_short_code": "",
"product_name": "",
"card_brand": "",
"card_virtual_indicator": "V",
"current_pin_attempt": "",
"max_pin_attempt": "",
"set_pin_indicator": "",
"statuses": [
{
"type": "BCC-CARD-982",
"value": "_",
"changed_date": "",
"description": "SPACE",
"contract_role": ""
}
],
"balances": [
{
"type": "AVAILABLE",
"currency": "AED",
"amount": "55000"
}
],
"custom_fields": [
{
"key": "",
"value": ""
}
]
}
]
}
}
}
}
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.