Prepaid Solutions

Overview

With our prepaid solution, you can extend prepaid products to customers without constraints such as credit rating, income, or bank account ownership. The solution includes issuer, branch, corporate, or cardholder web-based portals, enabling effortless sales, maintenance, load, and card or customer lifecycle management. These features empower non-banked customers to manage their finances like seasoned professionals, making financial management more accessible and straightforward.

Activate prepaid cards

Users can activate prepaid cards when they are first issued or after they have been deactivated for any reason.

Check card balances

Users can check the balance on a prepaid card in real-time or on a scheduled basis.

View transaction history

Users can view a detailed record of all transactions made with a prepaid card, including the date, time, amount, and location of each transaction.

 
Version

Client Create

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Client Create....

Overview

The Client Create API can be used by financial institutions to create new client records within our system. A client, in this context, can refer to a person or an organization.

The API allows institutions to input and store personal information, addresses, and identity documents associated with the client. The client record is the highest level in the data hierarchy and serves as the foundation for other related information, such as accounts and transactions.

The API allows institutions to input and store personal information, addresses, and identity documents associated with the client. The client record is the highest level in the data hierarchy and serves as the foundation for other related information, such as accounts and transactions. This API is typically used as a part of the onboarding process for new clients and can be integrated into existing systems and workflow.

Create Client Create Card Create Card

How It Works

When the API is called, it requires the input of certain information such as the client's name, contact information, and identification documents. This information is then processed and stored in the institution's database, creating a new client record.

In action, the API would be called by the financial institution's system, passing in the required information as parameters. The API would then process the information and create a new client record in the institution's database.

 

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

Client Create

Status:

Production

Version:

V2

Product:

Prepaid Solutions
/SB/CardServices/Transaction/V2/ClientCreate
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_CLIENT_CREATE”
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* requiredstring20Unique identifier of the client. The value should be unique for each transaction, else the API will be errored out with error message - “Duplicate client number”. 100000027 is sample value for reference please use different values for testing.
bank_code* requiredstring3Bank 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.
external_client_numberstring20This is additional unique identifier for the client.
card_name* requiredstring21Card embossing name defined on client level should be in Upper case
card_type* requiredstring7Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT
personal_detailsgenderstring6Gender of the client. The given options are - M: Male F: Female N: Not specified.
titlestring4The Title of the client. The expected options are - MR, MRS, MISS, MS, DR, Shaikh, Shaikha
first_name* requiredstring255First Name of the client
last_name* requiredstring255Last Name of the client
middle_namestring255Middle Name of the client
citizenshipstring3Citizenship of the client
marital_statusstring18Marital status of the client Expected values are - S: Single, M: Married, D: Divorced, X: Misc., W: Widow
date_of_birth* requiredstring15Birth Date of the client in the following format yyyy-mm-dd
place_of_birthstring255Birth place of the client
languagestring3This defines the language in which the user would like to recieve 3D secure OTP or any transactional notifications. By default notifications will be sent in English language. The value should be provided in ISO language format.
security_namestring255This field is used by Fraud monitoring agents to validate cardholder's verification on the call. This is not mandatory for issuers who are not using Fraud monitoring service
contact_detailshome_phonestring32Home phone number of the client, its recommended to pass the value with country code
work_phonestring32Work phone number of the client, its recommended to pass the value with country code
mobile_phone* requiredstring32Mobile phone of the client, its recommended to pass the value with country code
emailstring255Valid email address of the client
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_fieldskeystring20Custom Tag. Ex: client_type
valuestring128Tag value. Ex: CLIENT_PRIV

{
    "NISrvRequest": {
        "request_client_create": {
            "header": {
                "msg_id": "990742675747",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CLIENT_CREATE",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2023-09-11 14:11:54.822+0400",
                "tracking_id": "",
                "bank_id": "NIC"
            },
            "body": {
                "customer_id": "100000027",
                "bank_code": "982",
                "external_client_number": "100000027",
                "card_name": "JAMES ROBERT",
                "card_type": "CREDIT",
                "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": "client_type",
                        "value": "CLIENT_PRIV"
                    }
                ]
            }
        }
    }
}

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_CLIENT_CREATE”
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* requiredstring3Bank 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
external_client_numberstring20additional identifier for the client that is generated by FI system
card_name* requiredstring21Card embossing name defined on client level (Upper case)
personal_detailsgenderstring6Gender ex Male
titlestring4Title ex Mr
first_name* requiredstring255First Name ex James
last_name* requiredstring255Last Name ex Robert
middle_namestring255Last Name ex Ivich
citizenship* requiredstring3Citizenship
marital_statusstring18Marital Status
date_of_birth* requiredstring20Date of birth
place_of_birthstring255Place of birth
languagestring3Language ISO code
security_namestring255Security Name
contact_detailshome_phonestring32Home Phone Number
work_phonestring32Work Phone 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_fieldskeystring20Custom Tag. Ex: client_type
valuestring128Tag value. Ex: CLIENT_PRIV

{
    "NISrvResponse": {
        "response_client_create": {
            "header": {
                "msg_id": "99056447",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CLIENT_CREATE",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2024-02-15T15:36:40.447+04:00",
                "tracking_id": "",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-02-15T15:36:40.447+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "customer_id": "100000027",
                "bank_code": "982",
                "external_client_number": "100000027",
                "card_name": "JAMES ROBERT",
                "card_type": "CREDIT",
                "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-COMPANY_NAME",
                        "value": "ABC Pvt Ltd"
                    },
                    {
                        "key": "CL-DATE_OPEN",
                        "value": "2024-02-15 15:36:39"
                    },
                    {
                        "key": "CL-EMB_NAME_LAST",
                        "value": "JAMES ROBERT"
                    },
                    {
                        "key": "CL-INCOME",
                        "value": "0"
                    },
                    {
                        "key": "CL-IS_STAFF",
                        "value": "N"
                    },
                    {
                        "key": "CL-MOTHER_NAME",
                        "value": "Tima"
                    },
                    {
                        "key": "CL-NAME_FIRST",
                        "value": "James"
                    },
                    {
                        "key": "CL-NAME_LAST",
                        "value": "Robert"
                    },
                    {
                        "key": "CL-NAME_THIRD",
                        "value": "Ivich"
                    },
                    {
                        "key": "CL-NAME_TITLE",
                        "value": "MR"
                    },
                    {
                        "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

Code Description
* *