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

Accounts List

Status:

Production

Version:

V2

Category:

Account Services

Account List

Overview

A "list of accounts" API in a payment processing company allows users to retrieve a list of all client accounts in the payment processing system. This API is typically used by merchants or other businesses that want to view a list of all accounts that are registered in the payment processing system, for example, to manage which accounts are eligible for use in transactions or to view the status of a particular account.

How It Works

To utilize the 'account list' API, users must first provide their authentication credentials, such as a client secret and ID, to access the API. Once authenticated, the API retrieves a list of all accounts registered in the NI systems and returns it to the user.

End consumers benefit from using the 'account list' API by having a comprehensive view of all the accounts in the NI card management systems.

https://api-sandbox.network.global

Accounts List

Status:

Production

Version:

V2

Category:

Account Services
/SB/AccountServices/Enquiry/V2/ListOfAccounts
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* requiredstring12Unique Source Message ID
msg_type* requiredstring12Request Type Default TRANSACTION
msg_function* requiredstring50Function name to be used Default REQ_LIST_OF_ACCOUNTS
src_application* requiredstring10Source requesting channel Ex IVR
target_application* requiredstring10Target application name Ex PCMS
timestamp* requiredstring30Timestamp of the response Date u0026 time Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4Source Bank Id Ex bankID
bodycustomer_id* requiredstring32customer id
card_type* requiredstring20PREPAID/CREDIT/DEBIT

{
    "NISrvRequest": {
        "request_list_of_accounts": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_LIST_OF_ACCOUNTS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+0:00",
                "bank_id": "NIC"
            },
            "body": {
                "customer_id": "100000027",
                "card_type": "CREDIT"
            }
        }
    }
}

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

Node TypeTypeLengthDescription
headermsg_id* requiredstring12The msg_id sent in the request will be sent back in response in this field Unique Source Message ID eg ada123456fdsf
msg_type* requiredstring12msg_type sent in the request will be sent back in response in this field
msg_function* requiredstring50Default REP_LIST_OF_ACCOUNTS
src_application* requiredstring10The src_application sent in the request will be sent back in response in this field
target_application* requiredstring10The target_application sent in the request will be sent back in response in this field
timestamp* requiredstring30Timestamp of the response Date u0026 time Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4The bank_id sent in the request will be sent back in response in this field
exception_details
bodycard_identifier_id* requiredstring32Card Identifier Id
card_identifier_type* requiredstring4CONTRACT_NUMBER

{
    "NISrvResponse": {
        "response_list_of_accounts": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_LIST_OF_ACCOUNTS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "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"
            },
            "body": {
                "card_identifier_id": "2227230000508669",
                "card_identifier_type": "CONTRACT_NUMBER"
            }
        }
    }
}

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.