Debit Solutions

Overview

Our one-stop, centralised solution for Debit Card processing is designed to provide you with a seamless and secure payment experience. Whether you are a small business or a large enterprise, our solution is cost-effective, easily configurable and scalable to meet your specific needs.

With our Debit Card processing solution, you can easily accept payments from your customers and enjoy faster access to your funds. Our platform supports all major debit card networks, so you can accept payments from customers regardless of their bank.

Version

Card Insurance Product

Status:

Production

Version:

V2

Product:

Credit Solutions

Card Insurance Product

Overview

Card insurance enquiry provides access real-time information about insurance details for a specific card. This API allows businesses, developers, or other entities to programmatically retrieve insurances program details, which can be utilized for various purposes such as showing the available insurance programs, and the related status.

This API simplifies the process of accessing insurance information programmatically, such as:

How It Works

The Card insurance enquiry API sends the card identifier which returns all available insurance programs in the response. This will give you the option to list the insurance programs plus getting the related parameters like fee, grace period.

https://api-sandbox.network.global

Card Insurance Product

Status:

Production

Version:

V2

Product:

Credit Solutions
/V2/cardservices/CardInsuranceProduct
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_insurance_productheadermsg_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_INSURANCE_PRODUCT"
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

{
    "NISrvRequest": {
        "request_card_insurance_product": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_CARD_INSURANCE_PRODUCT",
                "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"
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_card_insurance_productheadermsg_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_INSURANCE_PRODUCT"
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.
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
insurance_productsnamestring255Name of the insurance (E.g. Credit Shield)
codestring2Code of the insurance - From 01 to 12
is_activestring32Business Reference of Status (CANCELLED|ACTIVE)
status_codestring10Status Code of the insurance (F,R,U,etc.)
status_namestring255Status name (Enrolled, Cancelled by User, etc.)
activation_datestring10Activation Date
deactivation_datestring10Deactivation Date
reinstatement_datestring10Reinstatement Date
parametersinsurance_companystring2Insurance company code
grace_period_durationstring2Duration of grace period
grace_period_typestring2Type of grace period
dlq_cancel_auto_reinstatestring2Number of auto-reinstatements after delay
dlq_cancel_man_reinstatestring2Number of manual reinstatements after delay
allow_zero_coveragestring1Allow zero coverage
max_coverage_behaviorstring1Max coverage behavior
minimum_feestring10Minimum fee
base_feestring10Base fee
percentagestring5Percentage
max_coveragestring10Maximum coverage
max_agestring3Maximum age for coverage

{
    "NISrvResponse": {
        "response_card_insurance_product": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_CARD_INSURANCE_PRODUCT",
                "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": "99984100111514120000",
                "card_identifier_type": "EXID",
                "insurance_products": [
                    {
                        "name": "Credit Shield",
                        "code": "01",
                        "is_active": "CANCELLED",
                        "status_code": "R",
                        "status_name": "Canceled at the request of the insured party",
                        "activation_date": "",
                        "deactivation_date": "",
                        "reinstatement_date": "",
                        "parameters": [
                            {
                                "insurance_company": "CS",
                                "grace_period_duration": "1",
                                "grace_period_type": "M",
                                "dlq_cancel_auto_reinstate": "3",
                                "dlq_cancel_man_reinstate": "4",
                                "allow_zero_coverage": "N",
                                "max_coverage_behavior": "A",
                                "minimum_fee": "5",
                                "base_fee": "0",
                                "percentage": "1",
                                "max_coverage": "7000",
                                "max_age": "51"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found