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 Update

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Client Update

Overview

A client update API in a payment processing company allows users to update information for an existing client account in the payment processing system. This API is typically used by merchants or other businesses that want to update their client's information in the payment processing system.

How It Works

To use the client update API, users will need to provide the unique client ID for the account they want to update, as well as the new information they want to save. The API will then update the client's information in the payment processing system and confirm that the update was successful.

One of the benefits of using a client update API is that it allows merchants to easily keep their client's information up-to-date in the payment processing system. This can be important for maintaining accurate billing and payment records, and for ensuring that transactions are processed smoothly.

It's important to note that the client update API may have certain security requirements and may require users to authenticate their identity before updating client accounts. This is to protect against unauthorized access and ensure the security and integrity of the payment processing system. Additionally, the API may have certain limits on the types of information that can be updated, or may require users to provide additional documentation or verification before making changes to a client's account.

https://api-sandbox.network.global

Client Update

Status:

Production

Version:

V2

Product:

Prepaid Solutions
/SB/CardServices/Transaction/V2/ClientUpdate
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_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”
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)
card_type* requiredstring7Values are restricted PREPAID CREDIT DEBIT
personal_detailsgenderstring6Gender
titlestring4Title MR etc
first_name* requiredstring255First Name
last_name* requiredstring255Last Name
middle_namestring255Middle Name
citizenshipstring3Citizenship
marital_statusstring18Marital status
date_of_birth* requiredstring10Birth Date
place_of_birthstring255Birth place
languagestring18Language 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
work_phonestring32Work phone
mobile_phone* requiredstring32Mobile phone
emailstring255Email Id
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_fieldskey* requiredstring20Custom Tag. Ex: client_type
value* requiredstring128Tag value. Ex: CLIENT_PRIV

{
    "NISrvRequest": {
        "request_client_update": {
            "header": {
                "msg_id": "2360018598",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CLIENT_UPDATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "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",
                    "email": "James.Robert@network.global",
                    "phone": "919702310992",
                    "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_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 sent in the request will be sent back in response in this field
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_details
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
client_numberstring20Customer ID: Customer Identification number This should be a unique number
card_name* requiredstring21Card embossing name defined on client level (Upper case)
personal_detailsgenderstring6Gender
titlestring4Title MR etc
first_name* requiredstring255First Name
last_name* requiredstring255Last Name
middle_namestring255Middle Name
citizenship* requiredstring3Citizenship
marital_statusstring18Marital status
date_of_birth* requiredstring10Birth Date
place_of_birthstring255Birth place
languagestring18Language 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
work_phonestring32Work phone
mobile_phonestring32Mobile phone
emailstring255Email Id
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_update": {
            "header": {
                "msg_id": "2360018598",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CLIENT_UPDATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2024-02-15T15:28:02.338+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-02-15T15:28:02.338+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": "1968-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-08 14:53:23"
                    },
                    {
                        "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