Account Services

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.

 
Download
Version
Account Create(Post)

The Account Create API allows for the creation of new customer accounts. Parameters include customer ID, card type, branch code, Product code, currency, and custom fields.

Status :Production
Version : V2
Try Out   
Accounts List(Post)

The List of Accounts API is a useful tool for payment processing companies that offer a range of financial products, such as credit cards, debit cards, and bank accounts. This API allows customers to easily view a list of all their accounts with the payment processing company, providing a convenient way to manage their finances and keep track of their spending.

Status :Production
Version : V2
Try Out   
Customer Details(Post)

A customer details enquiry API allows a payment processing company to retrieve information about a customer's account. This could be used, for example, by a merchant to get information about a customer's billing address or by a customer service representative to verify account details.

Status :Production
Version : V2
Try Out   
Account Update(Post)

This API allows for the updating of an existing account for a cardholder.

Status :Production
Version : V2
Try Out   
P2P Transfer(Post)

This API facilitates debiting from the "source identifier" and crediting to the "target identifier" for the requested amount within the same financial institution.

Status :Production
Version : V2
Try Out   
Account Status Change(Post)

This API updates block codes on the account level for an account identifier.

Status :Production
Version : V2
Try Out   
Account Balance Enquiry(Post)

The Account Balance API receives balance details of account numbers.

Status :Production
Version : V2
Try Out   
Account Hierarchy Enquiry(Post)

This API retrieves all accounts within a commercial or multi-currency hierarchy under a specific client ID or account number.

Status :Production
Version : V2
Try Out   
Account Transfer(Post)

This API is used to transfer account and its sub accounts and cards from one product to another.

Status :Production
Version : V2
Try Out   

Customer Details

Status:

Production

Version:

V2

Category:

Account Services

Customer Details

Overview

This API allows users to retrieve detailed information about a particular customer or client. This API is typically used by financial institutions to view detailed information about a particular customer, for example, to view the personal details, contact details or address of the customer.

Card information retrieval

This feature allows users to retrieve detailed information about a particular customer or client in the payment processing system, such as their name, contact information, account status, and any transactions or other activity associated with their account.

Security

This feature ensures that the API has the necessary security measures in place to protect against unauthorized access and ensure the security and integrity of the payment processing system. This may include measures such as authentication and encryption.

How It Works

To use the "customer details" API, users will need to provide the unique client ID for the customer they want to view details for, as well as any necessary authentication credentials. The API will then retrieve the relevant information about the customer from the payment processing system and return it to the user.

The information that is returned by the "customer details" API will depend on the specific details that are requested and the information that is available in the payment processing system. This may include information such as the customer's name, contact information, account status, and any transactions or other activity associated with their account.

Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

https://api-sandbox.network.global

Customer Details

Download

Status:

Production

Version:

V2

Category:

Account Services
/SB/CardServices/Enquiry/V2/CustomerDetails
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_GENERIC_CUSTOMER_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”
bodycustomer_id* requiredstring20Either Customer ID or Card Identifier Id
card_identifier_idstring32CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
card_identifier_typestring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS.
additional_qualifierstypestring32Additional qualifier works as additional qualifier with card_identifier_type example: searching by mobile number and last X digits of the card,card_identifier_type= MOBILE, and additionalQualifiers.type= PAN_LAST
valuestring128Additional qualifier works as additional qualifier with card_identifier_id based on the type

{
    "NISrvRequest": {
        "request_generic_customer_details": {
            "header": {
                "msg_id": "7567878",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GENERIC_CUSTOMER_DETAILS",
                "src_application": "SSP",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T06:49:02.366Z",
                "tracking_id": "7567878",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984100111514120378",
                "card_identifier_type": "EXID",
                "card_type": "PREPAID"
            }
        }
    }
}

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_GENERIC_CUSTOMER_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* requiredstring15Timestamp 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.
bodycustomer_id* requiredstring20Customer ID: Customer Identification number
This should be a unique number
bank_code* requiredstring5Bank code is Unique Id 3 digit number for each client and the same will be provided once the client setup is completed in our core system.
For sandbox testing – “982” is used
client_numberstring20Client number Ex: 000003548435901
card_name* requiredstring21Card embossing name defined on client level (Upper case)
personal_detailsgenderstring6Gender
titlestring5Title
first_name* requiredstring255First Name
last_name* requiredstring255Last Name
middle_namestring255Middle_name
citizenship* requiredstring3citizenship
marital_statusstring18Marital status
date_of_birth* requiredstring15Date of birth
place_of_birthstring255Place of birth
languagestring3Language ISO code
security_namestring255This field is used by Fraud monitoring agents to validate cardholder verification on call This is not mandatory for issuers not using Fraud monitoring service
contact_detailshome_phonestring32Home Phone Number
work_phonestring32Mobile Number
mobile_phonestring32Mobile Number
emailstring255Email address
addressesaddress_type* requiredstring20The type of the address, just like multiple phone number types, we can have multiple addresses type . Ex PERMANENT/PRESENT/WORK/HOME
address_line_1* requiredstring255Building Name of the address
address_line_2string255This defines wheather the address belongs to the Landlord or the Tenant.
address_line_3string255House Name or House Number of the address
address_line_4string255Street Name of the address
emailstring255Valid email address of the client
phonestring32Phone number
city* requiredstring255City name
country* requiredstring255Country Code Ex SAU
zipstring32Zip Code
statestring32State
identity_proof_documentnumberstring20An identity number can be any valid id number which is provided by government that may be used to prove a person's identity.
typestring20An identity document's type the expected document types are passport,nationalId,driving licence
expiry_datestring10The identity document's expiry date the format should be - YYYY-MM-DD
supplementary_documentsnumberstring20Supplemental documents are supporting materials
typestring20Supplemental documents are supporting materials
expiry_datestring10YYYY-MM-DD
employment_detailsemployer_namestring64Company Name of the client
incomestring64Income of the client
occupationstring64Occupation/Trade
custom_fieldskeystring20Client type Tag
valuestring128Tag value

{
    "NISrvResponse": {
        "response_generic_customer_details": {
            "header": {
                "msg_id": "1710844613",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GENERIC_CUSTOMER_DETAILS",
                "src_application": "SSP",
                "target_application": "WAY4",
                "timestamp": "2024-03-19T14:36:55.01+04:00",
                "tracking_id": "113",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-03-19T14:36:55.01+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "113"
            },
            "body": {
                "customer_id": "100000027",
                "bank_code": "982",
                "client_number": "100000027",
                "card_name": "JAMES ROBERT",
                "personal_details": {
                    "gender": "M",
                    "title": "MR",
                    "first_name": "James",
                    "last_name": "Robert",
                    "middle_name": "Ivich",
                    "citizenship": "ARE",
                    "marital_status": "M",
                    "date_of_birth": "1955-08-25",
                    "place_of_birth": "Dubai",
                    "language": "ENG",
                    "security_name": "Tima"
                },
                "contact_details": {
                    "home_phone": "919702310992",
                    "work_phone": "919702310992",
                    "mobile_phone": "919702310992",
                    "email": "James.Robert@network.global"
                },
                "addresses": [
                    {
                        "address_type": "PERMANENT",
                        "address_line_1": "Al Mahata Towers",
                        "address_line_2": "LandLord",
                        "address_line_3": "House no - 1105",
                        "address_line_4": "Al Qasmia",
                        "city": "Dubai",
                        "country": "ARE",
                        "zip": "24537",
                        "state": "Dubai"
                    }
                ],
                "identity_proof_document": [
                    {
                        "number": "R589856",
                        "type": "Passport",
                        "expiry_date": "2025-05-20"
                    }
                ],
                "supplementary_documents": [
                    {
                        "number": "R589856",
                        "type": "Passport",
                        "expiry_date": "2025-05-20"
                    }
                ],
                "employment_details": [
                    {
                        "employer_name": "ABC Pvt Ltd",
                        "income": "20000",
                        "occupation": "Engineer"
                    }
                ],
                "custom_fields": [
                    {
                        "key": "CL-CLIENT_PRIOR",
                        "value": "0"
                    },
                    {
                        "key": "CL-DATE_OPEN",
                        "value": "2024-02-08 14:53:23"
                    },
                    {
                        "key": "CL-INCOME",
                        "value": "0"
                    },
                    {
                        "key": "CL-IS_STAFF",
                        "value": "N"
                    },
                    {
                        "key": "CL-SAV_ACC_AM",
                        "value": "0"
                    },
                    {
                        "key": "CL-SCORE_LIMIT",
                        "value": "0"
                    },
                    {
                        "key": "CL-SCORE_LIMIT_APPR",
                        "value": "0"
                    },
                    {
                        "key": "CL-SCORE_VAL",
                        "value": "0"
                    },
                    {
                        "key": "CL-SEC_CH_AM",
                        "value": "0"
                    },
                    {
                        "key": "CL-SHORT_NAME",
                        "value": "Robert James"
                    }
                ]
            }
        }
    }
}

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.

1- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

2- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

3- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

4- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

5- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.