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

Get Restrictions

Status:

Production

Version:

V2

Product:

Credit Solutions

Get Restrictions API

Overview

This API enables customers to quickly and easily view any restrictions on their credit or debit cards, helping them to make informed decisions about their spending.

How It Works

Once the customer's identity has been verified, the API retrieves the requested information from the payment processing company's database. This information includes data on the customer's transaction restrictions, approved or declined merchant categories, and countries where their card can be used. Overall, the Get Restrictions API is a powerful tool that enables payment processing companies to provide their customers with quick and easy access to information about their card restrictions. By leveraging advanced security protocols and customizable features, the API helps to improve customer satisfaction and loyalty, while also streamlining internal operations.

https://api-sandbox.egy.network.global

Get Restrictions

Status:

Production

Version:

V2

Product:

Credit Solutions
/V2/cardservices/GetRestrictions
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
headermsg_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 “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REQ_GET_RESTRICTION_USAGE_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
filterstring255limit type can be list of usage codes (comma separated)

{
    "NISrvRequest": {
        "request_get_restriction_usage_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GET_RESTRICTION_USAGE_DETAILS",
                "src_application": "BNK",
                "target_application": "CARD_CONTROL",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984100148297467162",
                "card_identifier_type": "EXID",
                "filter": "ATM"
            }
        }
    }
}

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

Node TypeTypeLengthDescription
headermsg_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_GET_RESTRICTION_USAGE_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 response - 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* requiredstring20 Application Name
date_time* requiredstring30 Timestamp of the response Format YYYY-MM-DD HH:MM:SS
status* requiredstring1 Status of the request (S/F)
error_code* requiredstring4 EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100 Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20 The tracking_id sent in the request will be sent back in response in this field.
bodyrestrictionsrestriction_typestring100Type of restrictions Restriction Type MOTO - Mail Order Telephone Order INTERNATIONAL - International Transaction ECOM - e-Commerce PERS_RESTR_CONTACTLESS - Contactless Transaction NFC - controls POS transactions only ATM - ATM Transaction ANY - Any Debit Transaction PURCHASE - Purchase Transactions INTERNATIONAL_SPECIFIC_COUNTRIES - foreign specific countries
isAllowedbooleanIs Allowed - The values expected - true/false
end_datestring10End date
allowed_valuesstring100Allowed values (in case of Restriction-type = INTERNATIONAL_SPECIFIC_COUNTRIES, please input comma seperated list of country codes here)

{
    "NISrvResponse": {
        "response_get_restriction_usage_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GET_RESTRICTION_USAGE_DETAILS",
                "src_application": "BNK",
                "target_application": "CARD_CONTROL",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "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": {
                "restrictions": [
                    {
                        "restriction_type": "PURCHASE",
                        "isAllowed": true,
                        "end_date": "2023-09-01T00:00:00.000Z",
                        "allowed_values": "2023-09-01T00:00:00.000Z"
                    }
                ]
            }
        }
    }
}

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