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 Details Enquiry
Status:
Production
Version:
V2
Category:
Card Services
Card Details Enquiry
Overview
The Card Details API enables businesses to obtain detailed information about a specific card. The API requires the card identifier as an input parameter and returns the requested information in a JSON format. The information returned by the API includes the primary account number (PAN), the product associated with the card, various statuses and balances associated with the card, and other relevant details. This feature allows businesses to access and utilize the card information to support various card-related operations, such as transactions, card management, and customer service.
Retrieval of card information
This API allows users to retrieve important details about a card, including the PAN, product, statuses, and balances.
Card status tracking
Users can use this API to track the status of a card by providing the card identifier and institution ID.
Card limit information
Users can access card limit information through this API.
How It Works
This API allows businesses to retrieve detailed information about a specific card, including the card's number, the product associated with the card, various statuses and balances associated with the card, and other relevant information.
The API takes the card identifier as input and returns the requested information in a way that is easy to understand and use for the business. This information can be used to better manage and track the use of the card, troubleshoot any issues, and make more informed decisions about the card's usage.
Overall, this API helps businesses to have a better understanding of the card and its associated details.
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 Details 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_details | 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_DETAILS" | |||||||
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 | |||||||
card_expiry_date | string | 4 | YYMM | |||||||
card_sequence_number | string | 2 | Sample Values 01 | |||||||
balance_list | string | 512 | DUE,PAST_DUE |
{
"NISrvRequest": {
"request_card_details": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_CARD_DETAILS",
"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",
"card_expiry_date": "2812",
"card_sequence_number": "1",
"balance_list": "1"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_card_details | 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_DETAILS" | |||||||
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 | 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 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 | |||||||
RBS_number | string | 64 | RBS is Core banking system number | |||||||
masked_pan | string | 16 | Masked PAN of the card | |||||||
card_external_identifier_id | string | 32 | card external identifier id | |||||||
clear_pan | string | 16 | Clear card no of the card | |||||||
card_expiry_date | string | 4 | YYMM Ex: 2310 | |||||||
cardholder_name | string | 26 | Card holder's name | |||||||
account_number | string | 50 | Account number | |||||||
product_code | string | 32 | Product group | |||||||
product_group | string | 32 | Product group | |||||||
product_short_code | string | 32 | Product short code | |||||||
product_name | string | 32 | Product name | |||||||
product_profile | string | 7 | Pricing Control Tables | |||||||
card_brand | string | 32 | Card brand | |||||||
card_role | string | 1 | P (Primary) / S (Supplementary) | |||||||
last_statement_date | string | 10 | Last Statement Date | |||||||
next_statement_date | string | 10 | Next Statement Date | |||||||
due_date | string | 10 | Due date - This is applicable only for the credit cards | |||||||
card_date_open | string | 10 | Card open date | |||||||
card_activation_date | string | 10 | Card activation date | |||||||
currency | string | 3 | Currency , Example - AED | |||||||
card_virtual_indicator | string | 1 | P for Physical, V for virtual | |||||||
current_pin_attempt | string | 3 | Current pin attempt | |||||||
max_pin_attempt | string | 3 | Max pin attempt | |||||||
external_client_number | string | 20 | This is additional unique identifier for the client. | |||||||
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 | |||||||
limits | type | string | 32 | Credit limit typapplicable only for credit card products | ||||||
currency | string | 3 | Credit limit currency - applicable only for credit card products | |||||||
value | string | 20 | Credit limit value - applicable only for credit card products | |||||||
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_details": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_CARD_DETAILS",
"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",
"institution_id": "982",
"card_identifier_id": "99984100111514120000",
"card_identifier_type": "EXID",
"RBS_number": "123456789",
"masked_pan": "999841XXXXXX5605",
"card_external_identifier_id": "51247542187367224743",
"clear_pan": "9998410029355605",
"card_expiry_date": "3001",
"cardholder_name": "JOHN DOE",
"account_number": "0009821110000000049",
"product_code": "982_AED_002_P",
"product_group": "",
"product_short_code": "",
"product_name": "",
"product_profile": "",
"card_brand": "",
"card_role": "P",
"last_statement_date": "",
"next_statement_date": "15\/01\/2025",
"due_date": "",
"card_date_open": "01\/01\/2022",
"card_activation_date": "01\/01\/2025",
"currency": "AED",
"card_virtual_indicator": "V",
"current_pin_attempt": "1",
"max_pin_attempt": "2",
"external_client_number": "100000027",
"statuses": [
{
"type": "BCC-CARD-982",
"value": "_",
"changed_date": "",
"description": "SPACE",
"contract_role": ""
}
],
"limits": [
{
"type": "FIN_LIMIT",
"currency": "AED",
"value": "55000"
}
],
"balances": [
{
"type": "",
"currency": "AED",
"amount": ""
}
],
"wallets": [
{
"wallet_identifier_id": "",
"wallet_identifier_type": "",
"currency": "",
"priority": "",
"role": "",
"balances": [
{
"type": "AVAILABLE",
"currency": "AED",
"amount": "55000"
}
]
}
]
}
}
}
}
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.