Card Control Services

Overview

Our card control services allow you to manage your customers' cards with ease, providing an extra layer of security and flexibility. You can set custom limits on transactions for each card, such as daily or weekly limits, and even limit transactions to specific merchant categories or locations.

In the event of a lost or stolen card, our platform allows you to quickly block the card to prevent fraudulent transactions. You can also unblock the card when it's found or issue a replacement card directly through the platform.

With our real-time transaction monitoring, you can track your customers' card usage and receive instant alerts for suspicious or unauthorized transactions. This allows you to take immediate action to prevent fraud and protect your customers' accounts.

Version

Get Limits

Status:

Production

Version:

V2

Category:

Card Control Services

Get Limit Usage Details

Overview

The 'Get Limits' API provides a way for users to retrieve specific limit information related to a given card, with options to filter results and specify query scope and channel.

How It Works

The 'Get Limits' API allows consumers to retrieve specific limit information related to a given card by specifying the unique identifier associated with the card. This API provides flexibility with the ability to filter results, specify the scope of the query, and choose the channel through which the query is made. This functionality is particularly useful for businesses that deal with credit or debit cards, enabling them to quickly access relevant limit information to make informed decisions.

https://api-sandbox.network.global

Get Limits

Status:

Production

Version:

V2

Category:

Card Control Services
/SB/CardServices/Enquiry/V2/GetLimits
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 “ENQUIRY”
msg_function* requiredstring50Message functions: Should be “REQ_GET_LIMITER_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_limiter_usage_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GET_LIMITER_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": "DAILY"
            }
        }
    }
}

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_LIMITER_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.
bodylimitslimit_typestring100 Card Usage Limit.
currencystring3 Currency.
max_amountstring18 Maximum amount that can be used.
current_amountstring18 Amount that is currently been used.
is_activeboolean0 This flag indicates to identify if the usage limit is active or not.

{
    "NISrvResponse": {
        "response_get_limiter_usage_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GET_LIMITER_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": {
                "limits": [
                    {
                        "limit_type": "DAILY",
                        "currency": "AED",
                        "max_amount": "5000",
                        "current_amount": "2000",
                        "is_active": true
                    }
                ]
            }
        }
    }
}

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

How It Works

Follow the steps below. For more details, read the Quick Start Guide.