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:

Version

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.

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.

https://api-sandbox.network.global

Card SDM Details Enquiry

Status:

Production

Version:

V2

Product:

Debit Solutions
/Enquiry/V2/CardSDMDetailsEnquiry
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_card_sdm_detailsheadermsg_id* requiredstring12Message 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* requiredstring12Message Type: This can have either 'TRANSACTION' or 'ENQUIRY'. As for this API, the value expected is 'ENQUIRY'.
msg_function* requiredstring50Static Value - REQ_CARD_SDM_DETAILS
src_application* requiredstring10Source 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* requiredstring10The 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* requiredstring30Timestamp of the request - Format: YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank 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'.
bodycard_identifier_id* requiredstring32Card identifier
card_identifier_type* requiredstring20CONTRACT_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-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_card_sdm_detailsheadermsg_id* requiredstring12Unique Source Message ID eg ada123456fdsf
msg_type* requiredstring12Message Type – This can have either 'TRANSACTION' or 'ENQUIRY' As for this API the value expected is 'ENQUIRY'
msg_function* requiredstring50Default REP_CARD_SDM_DETAILS
src_application* requiredstring10Source 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* requiredstring10The 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* requiredstring15Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank 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_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format 'YYYY-MM-DD HH:MM:SS'
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.
bodycard_identifier_id* requiredstring32CardValue of card number, Token number, Ext_number
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
masked_pan* requiredstring16Masked PAN
card_virtual_indicator* requiredstring1P- Physical V- Virtual
card_name* requiredstring21Card embossing name defined on client level should be in Upper case
cardholder_name* requiredstring21Cardholder Name
card_date_open* requiredstring10Card open date
statusestypestring10Status type
valuestring10Status value
changed_datestring10Date of status change
descriptionstring100Brief description
contract_rolestring3Role of top contract
custom_fieldskeystring32Custom Tag e.g. contract_idt_scheme
valuestring128Custom 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
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found