Account Services

Overview

Our account-related APIs are a powerful set of APIs that provide businesses with a flexible and scalable way to manage their customers' accounts. These APIs enable businesses to streamline their account management process, making it easier for them to create, update, and manage customer accounts, while also providing a seamless and personalized customer experience.

One of the key features of our account-related APIs is the account creation functionality. With this API, businesses can easily create new customer accounts, while also ensuring that each account is unique and identifiable. This can be done by including customer-specific information, such as their name, email address, and contact information, as part of the account creation process.

Another important functionality of our account-related APIs is account updation. This API enables businesses to update existing customer accounts with new information, such as changes to their contact information, billing information, or account preferences. By using this API, businesses can ensure that customer account information is always up-to-date and accurate, helping to improve the overall customer experience.

In addition to these functionalities, our account-related APIs also include account listing functionality. This API provides a way for businesses to retrieve a list of all customer accounts or a subset of customer accounts based on specific criteria. This can be useful for businesses that need to segment their customers based on certain attributes, such as geographic location, account type, or other demographic factors.

Overall, our account-related APIs provide businesses with a comprehensive set of tools for managing customer accounts, enabling them to provide a seamless and personalized customer experience, while also improving their operational efficiency and scalability.

Version

Account Update

Status:

Production

Version:

V2

Category:

Account Services

Account Update

Overview

This API allows for the updating of an existing account for a specific client, and this account will be linked to a specific product.

How It Works

This API allows for the updating of an existing account for a specific client. It will take the client identifier as an input, which can be in the form of a unique ID or any other client identifier that is used in the system. The API will then use this identifier to update the account under the specific client. The account number can be passed as an input as part of this API.

A mandatory input for this API is the product code, which is used to identify the product that the account will be linked to. The product code will be used to retrieve all the related parameters, such as the account type, transaction limits, features, and services associated with the product.

Once all the necessary inputs are provided, the API will update the existing account and link it to the client and the specific product. The account will be activated and the client will be able to access the account and manage their transactions and balances.

For Multi-currency products, when creating new wallets, you have two options:













 
  1. Option 1: Send the key CN-WALLET_LIST_ADD under custom_fields with the value as a list of the desired wallets (e.g., 'USD, LBP').
  2. Option 2: Send the key CN-WALLET_LIST under custom_fields, including the already existing wallets in the list (e.g., 'AED, USD, LBP'). With this option, the order of the currencies will determine the wallet priority.

If you only need to update the priority of the wallets, you can use the CN-WALLET_LIST option.

 

https://api-sandbox.network.global

Account Update

Status:

Production

Version:

V2

Category:

Account Services
/SB/AccountServices/Transaction/V2/AccountUpdate
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_ACCOUNT_UPDATE”
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”
bodyaccount_number* requiredstring64Account number
card_type* requiredstring7Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT
accountcustomer_id* requiredstring20Customer ID: Customer Identification number This should be a unique number
branch_code* requiredstring10Branch Code, if no branches are used, the code must be same as bank_code
account_number* requiredstring64Account number (This can not be updated)
custom_fieldskeystring20Custom Tag. Ex: CN-RBS_NUMBER
valuestring128Tag value. Ex: 9998881110000000

{
    "NISrvRequest": {
        "request_account_update": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_ACCOUNT_UPDATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "account_number": "0009821110000000008",
                "card_type": "CREDIT",
                "account": {
                    "customer_id": "100000027",
                    "branch_code": "982",
                    "account_number": "0009821110000000008",
                    "custom_fields": [
                        {
                            "key": "CN-RBS_NUMBER",
                            "value": "9998881110000000"
                        }
                    ]
                }
            }
        }
    }
}

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 “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REP_ACCOUNT_UPDATE”
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.
bodyaccount_number* requiredstring64Account number
custom_fieldskeystring20Custom Tag. Ex: CN-RBS_NUMBER
valuestring128Tag value. Ex: 9998881110000000

{
    "NISrvResponse": {
        "response_account_update": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_ACCOUNT_UPDATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2024-02-15T15:35:10.923+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-02-15T15:35:10.923+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "account_number": "0009821110000000008",
                "custom_fields": [
                    {
                        "key": "CN-AECB_STATUS_TYPE",
                        "value": "_"
                    },
                    {
                        "key": "CN-AMF_WAIVER_A",
                        "value": "N"
                    },
                    {
                        "key": "CN-BC_A1",
                        "value": "_"
                    },
                    {
                        "key": "CN-BC_A2",
                        "value": "_"
                    },
                    {
                        "key": "CN-CARD_TARIFF",
                        "value": "PCT_003"
                    },
                    {
                        "key": "CN-CONTRACT_NAME",
                        "value": "Last First"
                    },
                    {
                        "key": "CN-CREDIT_LIMIT_AM",
                        "value": "0"
                    },
                    {
                        "key": "CN-CRLIM_MAX_IGNORE_PE",
                        "value": "N"
                    },
                    {
                        "key": "CN-DATE_OPEN",
                        "value": "2024-02-04"
                    },
                    {
                        "key": "CN-DD_DAY",
                        "value": "0"
                    },
                    {
                        "key": "CN-DD_ENROLMENT",
                        "value": "N"
                    },
                    {
                        "key": "CN-DD_PCNT",
                        "value": "0"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-01",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-02",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-03",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-04",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-05",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-06",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-07",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-08",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-09",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-10",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-11",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-12",
                        "value": "_"
                    },
                    {
                        "key": "CN-INTEREST_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-LPF_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-LTY_ACCR_WAIVER",
                        "value": "Y"
                    },
                    {
                        "key": "CN-LTY_ENROLMENT",
                        "value": "N"
                    },
                    {
                        "key": "CN-MMF_WAIVER_A",
                        "value": "N"
                    },
                    {
                        "key": "CN-MTP_FLAG",
                        "value": "N"
                    },
                    {
                        "key": "CN-OVL_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-RBS_NUMBER",
                        "value": "9998881110000000"
                    },
                    {
                        "key": "CN-SAV_ACC_AM",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_LIMIT",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_LIMIT_APPR",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_VAL",
                        "value": "0"
                    },
                    {
                        "key": "CN-SEC_CH_AM",
                        "value": "0"
                    },
                    {
                        "key": "CN-SMS_ENROLMENT",
                        "value": "Y"
                    },
                    {
                        "key": "CN-STMT_FEE_WAIVE_PERS",
                        "value": "N"
                    },
                    {
                        "key": "CN-STMT_FLAG_PE",
                        "value": "B"
                    },
                    {
                        "key": "CN-TEMP_CREDIT_LIMIT_AM",
                        "value": "0"
                    }
                ]
            }
        }
    }
}

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.