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 Details Enquiry

Status:

Production

Version:

V2

Product:

Debit Solutions

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.

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.

https://api-sandbox.network.global

Card Details Enquiry

Status:

Production

Version:

V2

Product:

Debit Solutions
/SB/CardServices/Enquiry/V2/CardDetailsEnquiry
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_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* requiredstring50Message functions: Should be "REQ_CARD_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* requiredstring30Timestamp 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”
bodycard_identifier_id* requiredstring32Card Identifier Id
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
card_expiry_datestring4YYMM
card_sequence_numberstring2Sample Values 01
balance_liststring512DUE,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-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_card_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* requiredstring50Message functions: Should be "REP_CARD_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 resopnse - 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.
bodycustomer_id* requiredstring20Customer ID: Customer Identification number This should be a unique number
institution_id* requiredstring5institution 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* requiredstring32Card identifier id
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
RBS_numberstring64RBS is Core banking system number
masked_pan* requiredstring16Masked PAN of the card
card_external_identifier_idstring32card external identifier id
clear_panstring16Clear card no of the card
card_expiry_date* requiredstring4YYMM Ex: 2310
cardholder_name* requiredstring26Card holder's name
account_number* requiredstring50Account number
product_codestring32Product group
product_groupstring32Product group
product_short_codestring32Product short code
product_namestring32Product name
product_profilestring7Pricing Control Tables
card_brandstring32Card brand
card_role* requiredstring1P (Primary) / S (Supplementary)
last_statement_date* requiredstring10Last Statement Date
next_statement_date* requiredstring10Next Statement Date
due_date* requiredstring10Due date - This is applicable only for the credit cards
card_date_open* requiredstring10Card open date
card_activation_date* requiredstring10Card activation date
currency* requiredstring3Currency , Example - AED
card_virtual_indicator* requiredstring1P for Physical, V for virtual
current_pin_attemptstring3Current pin attempt
max_pin_attemptstring3Max pin attempt
external_client_numberstring20This is additional unique identifier for the client.
statusestypestring10Status type
valuestring10Status value
changed_datestring10Date of status change
descriptionstring100Brief description
contract_rolestring3Role of top contract
limitstypestring32Credit limit typapplicable only for credit card products
currencystring3Credit limit currency - applicable only for credit card products
valuestring20Credit limit value - applicable only for credit card products
balancestypestring32Type of the balance
currencystring3Currency
amountstring20Balance ammount
walletswallet_identifier_idstring64Wallet Account Number
wallet_identifier_typestring15Wallet Identifier Type
currencystring3Wallet Currency
prioritystring3Wallet priority
rolestring3Wallet Role
balancestype* requiredstring32Balance type
currency* requiredstring5Currency
amountstring20Balance 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
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found