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

Status:

Production

Version:

V2

Product:

Credit Solutions

Card Balance Enquiry

Overview

This API, designed to retrieve balances for a specified card, retrieves information such as the available amount, blocked or memo amount, due amount, and overdue amount. It should be noted that this API can only be utilized when the balances are stored in Network International's systems. It is not applicable for debit cards or prepaid cards with external store of value or wallets.

How It Works

This API is used to retrieve balance information for a specific card. When called, the API will return details on the available amount, blocked or memo amount, due amount, and overdue amount associated with the card. It should be noted that in order for this API to work, the balance information for the card must be stored in the systems of Network International.

This means that the API will not work for debit cards or prepaid cards that have an external store of value or are linked to a digital wallet. The API will take the card number as an input and return the balance information in a JSON format. This information can then be used to help businesses or financial institutions keep track of their customers' card usage and financial status.
Wallets object in the response is only applicable for multi-currency product, in which the list of wallets will be part of the response.

https://api-sandbox.network.global

Card Balance Enquiry

Status:

Production

Version:

V2

Product:

Credit Solutions
/SB/CardServices/Enquiry/V2/CardBalanceEnquiry
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_balance_enquiryheadermsg_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_BALANCE_ENQUIRY”
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
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_datestring4Expiry Format YYMM
balance_liststring512List of required balance types. Example AVAILABLE,BLOCKED

{
    "NISrvRequest": {
        "request_card_balance_enquiry": {
            "header": {
                "msg_id": "7t88277687",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_CARD_BALANCE_ENQUIRY",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "7t88277687",
                "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_balance_enquiryheadermsg_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 RES_CARD_BALANCE_ENQUIRY
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
timestampstring15Timestamp 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* 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
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_date* requiredstring4YYMM Ex: 2310
cardholder_name* requiredstring21Cardholder Name
account_number* requiredstring64Account number
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_balance_enquiry": {
            "header": {
                "msg_id": "1710844286",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_CARD_BALANCE_ENQUIRY",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2024-03-19T14:31:26.21+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-03-19T14:31:26.21+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "customer_id": "100000027",
                "institution_id": "982",
                "card_identifier_id": "99984100111514120378",
                "card_identifier_type": "EXID",
                "card_expiry_date": "3001",
                "cardholder_name": "JOHN DOE",
                "account_number": "0009821110000000049",
                "balances": [
                    {
                        "type": "DUE",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "PAST_DUE",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "TOTAL_DUE",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "BAL_INST",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "AVAILABLE",
                        "currency": "AED",
                        "amount": "55000.00"
                    },
                    {
                        "type": "BLOCKED",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "TOTAL_BALANCE",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "IPP_RET-LOAN-UNB",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "DIRECT_DEBIT",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "REPAYABLE",
                        "currency": "AED",
                        "amount": "0.00"
                    },
                    {
                        "type": "AVAILABLE_CASH",
                        "currency": "AED",
                        "amount": "33000.00"
                    },
                    {
                        "type": "PAYMENT",
                        "currency": "AED",
                        "amount": "0.00"
                    }
                ]
            }
        }
    }
}

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