Credit Solutions
Overview
Prepaid card services in NI allow users to access and use prepaid cards in the payment processing system. Prepaid cards are a type of payment card that are loaded with a specific amount of funds, which can be used to make purchases or withdraw cash at locations that accept the card.Users of prepaid card services in a payment processing company can typically:
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.
Protect against fraud
Users can access measures to detect and prevent fraudulent activity on prepaid cards, such as monitoring for suspicious activity or requiring additional authentication for certain 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.
Card SDM Details Enquiry
Status:
Production
Version:
V2
Product:
Debit Solutions
Card SDM Details Enquiry
Overview
The Card SDM 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 product associated with the card, various statuses, and other SDM elements at the contract level. 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 SDM information
This API allows users to retrieve key SDM details about a card, including the product type, contract-level statuses, and other relevant SDM elements.
Card status tracking
Users can use this API to track the contract-level status of a card by providing the card identifier and institution ID.
Contract-Level SDM Elements
Users can access SDM elements such as card configuration, service flags, and other contract-level attributes through this API.
How It Works
By sending the card identifier, we fetch SDM details like product type, contract-level statuses, and other relevant SDM elements, and return them in the response to support card-related operations.
Status:
Production
Version:
V2
Product:
Debit 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_card_sdm_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 | Static Value - REQ_CARD_SDM_DETAILS | |||||||
src_application | string | 10 | Source Application: This is a free text field and the client can populate the source system from where the API is initiated. Example: IVR, IB, MB. No validations of these are enforced at Network Systems. | |||||||
target_application | string | 10 | The target_application can hold any value from the 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 a unique 4-digit code for each client and 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_card_sdm_details": {
"header": {
"msg_id": "8790338086",
"msg_type": "ENQUIRY",
"msg_function": "REQ_CARD_SDM_DETAILS",
"src_application": "WARBA",
"target_application": "WAY4",
"timestamp": "2025-07-04T19:30:24.752Z",
"tracking_id": "1",
"bank_id": "WARBA"
},
"body": {
"card_identifier_id": "5172198000955826",
"card_identifier_type": "CONTRACT_NUMBER"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_card_sdm_details | 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_CARD_SDM_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 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 | card_identifier_id | string | 32 | CardValue of card number, Token number, Ext_number | ||||||
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 | |||||||
masked_pan | string | 16 | Masked PAN | |||||||
card_virtual_indicator | string | 1 | P- Physical V- Virtual | |||||||
card_name | string | 21 | Card embossing name defined on client level should be in Upper case | |||||||
cardholder_name | string | 21 | Cardholder Name | |||||||
card_date_open | string | 10 | Card open date | |||||||
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 | |||||||
custom_fields | key | string | 32 | Custom Tag e.g. contract_idt_scheme | ||||||
value | string | 128 | Custom Tag value |
{
"NISrvResponse": {
"response_card_sdm_details": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_CARD_SDM_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": {
"card_identifier_id": "99985101161390700708",
"card_identifier_type": "EXID",
"masked_pan": "999851XXXXXX8349",
"card_virtual_indicator": "V",
"card_name": "JAMES ROBERT",
"cardholder_name": "JOHN DOE",
"card_date_open": "01\/01\/2022",
"statuses": [
{
"type": "BCC-CARD-982",
"value": "_",
"changed_date": "",
"description": "SPACE",
"contract_role": ""
}
],
"custom_fields": [
{
"key": "contract_idt_scheme",
"value": "CONTRACT_NUMBER"
}
]
}
}
}
}
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 |