Credit Solutions
Overview
Prepaid card services in NI allow users to access and use prepaid cards in the payment processing system. Prepaid cards are a type of payment card that are loaded with a specific amount of funds, which can be used to make purchases or withdraw cash at locations that accept the card.Users of prepaid card services in a payment processing company can typically:
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.
Reload cards
Users can add funds to a prepaid card, either by transferring money from another account or by purchasing a reload card.
Resolve disputes
Users can access a process for resolving disputes or issues that may arise with prepaid card transactions.
Protect against fraud
Users can access measures to detect and prevent fraudulent activity on prepaid cards, such as monitoring for suspicious activity or requiring additional authentication for certain transactions.
Manage card accounts
Users can view and manage their prepaid card accounts, including the ability to set spending limits, view transaction history, and update personal information.
Client Update
Status:
Production
Version:
V2
Product:
Debit 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.
Tokenization
The API uses tokenization to protect sensitive payment information and comply with PCI-DSS.
Customer profile management
The API can be used to update and manage the customer's profile, including options to update or delete the account.
Security
The API uses security measures such as encryption and authentication to protect sensitive customer information and comply with data protection regulations.
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.
Client Update
Status:
Production
Version:
V2
Product:
Debit Solutions
Node | Child Node | Type | Length | Description |
---|---|---|---|---|
Authorization | Bearer xxxx | string | Authorization Header (Bearer Token) | |
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
header | msg_id | string | 12 | Message 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 | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION” | |||||||
msg_function | string | 50 | Message functions: Should be “REQ_CLIENT_UPDATE” | |||||||
src_application | string | 10 | Source 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 | string | 10 | The 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 | string | 30 | Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
bank_id | string | 4 | Bank 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” | |||||||
body | customer_id | string | 20 | Customer ID: Customer Identification number This should be a unique number | ||||||
bank_code | string | 3 | Bank 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_number | string | 20 | additional identifier for the client that is generated by FI system | |||||||
card_name | string | 21 | Card embossing name defined on client level (Upper case) | |||||||
card_type | string | 7 | Values are restricted PREPAID CREDIT DEBIT | |||||||
personal_details | gender | string | 6 | Gender | ||||||
title | string | 4 | Title MR etc | |||||||
first_name | string | 255 | First Name | |||||||
last_name | string | 255 | Last Name | |||||||
middle_name | string | 255 | Middle Name | |||||||
citizenship | string | 3 | Citizenship | |||||||
marital_status | string | 18 | Marital status | |||||||
date_of_birth | string | 10 | Birth Date | |||||||
place_of_birth | string | 255 | Birth place | |||||||
language | string | 18 | Language ISO code | |||||||
security_name | string | 255 | This 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_details | home_phone | string | 32 | Home phone | ||||||
work_phone | string | 32 | Work phone | |||||||
mobile_phone | string | 32 | Mobile phone | |||||||
string | 255 | Email Id | ||||||||
addresses | address_type | string | 20 | The type of the address, just like multiple phone number types, we can have multiple addresses type . Ex PERMANENT/PRESENT/WORK/HOME | ||||||
address_line_1 | string | 255 | Building Name of the address | |||||||
address_line_2 | string | 255 | This defines wheather the address belongs to the Landlord or the Tenant. | |||||||
address_line_3 | string | 255 | House Name or House Number of the address | |||||||
address_line_4 | string | 255 | Street Name of the address | |||||||
string | 255 | Valid email address of the client | ||||||||
phone | string | 32 | Phone number | |||||||
city | string | 255 | City name | |||||||
country | string | 255 | Country Code Ex SAU | |||||||
zip | string | 32 | Zip Code | |||||||
state | string | 32 | State | |||||||
identity_proof_document | number | string | 20 | An identity number can be any valid id number which is provided by government that may be used to prove a person's identity. | ||||||
type | string | 20 | An identity document's type the expected document types are passport,nationalId,driving licence | |||||||
expiry_date | string | 10 | The identity document's expiry date the format should be - YYYY-MM-DD | |||||||
supplementary_documents | number | string | 20 | Supplemental documents are supporting materials | ||||||
type | string | 20 | Supplemental documents are supporting materials | |||||||
expiry_date | string | 10 | YYYY-MM-DD | |||||||
employment_details | employer_name | string | 64 | Company Name of the client | ||||||
income | string | 64 | Income of the client | |||||||
occupation | string | 64 | Occupation/Trade | |||||||
custom_fields | key | string | 20 | Custom Tag. Ex: client_type | ||||||
value | string | 128 | Tag 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-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
header | msg_id | string | 12 | Message 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 | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION” | |||||||
msg_function | string | 50 | Message functions: Should be “REP_CLIENT_UPDATE” | |||||||
src_application | string | 10 | Source 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 | string | 10 | The target_application sent in the request will be sent back in response in this field | |||||||
timestamp | string | 15 | Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
bank_id | string | 4 | Bank 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 | ||||||||||
body | customer_id | string | 20 | Customer ID: Customer Identification number This should be a unique number | ||||||
bank_code | string | 3 | Bank 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_number | string | 20 | Customer ID: Customer Identification number This should be a unique number | |||||||
card_name | string | 21 | Card embossing name defined on client level (Upper case) | |||||||
personal_details | gender | string | 6 | Gender | ||||||
title | string | 4 | Title MR etc | |||||||
first_name | string | 255 | First Name | |||||||
last_name | string | 255 | Last Name | |||||||
middle_name | string | 255 | Middle Name | |||||||
citizenship | string | 3 | Citizenship | |||||||
marital_status | string | 18 | Marital status | |||||||
date_of_birth | string | 10 | Birth Date | |||||||
place_of_birth | string | 255 | Birth place | |||||||
language | string | 18 | Language ISO code | |||||||
security_name | string | 255 | This 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_details | home_phone | string | 32 | Home phone | ||||||
work_phone | string | 32 | Work phone | |||||||
mobile_phone | string | 32 | Mobile phone | |||||||
string | 255 | Email Id | ||||||||
addresses | address_type | string | 20 | The type of the address, just like multiple phone number types, we can have multiple addresses type . Ex PERMANENT/PRESENT/WORK/HOME | ||||||
address_line_1 | string | 255 | Building Name of the address | |||||||
address_line_2 | string | 255 | This defines wheather the address belongs to the Landlord or the Tenant. | |||||||
address_line_3 | string | 255 | House Name or House Number of the address | |||||||
address_line_4 | string | 255 | Street Name of the address | |||||||
string | 255 | Valid email address of the client | ||||||||
phone | string | 32 | Phone number | |||||||
city | string | 255 | City name | |||||||
country | string | 255 | Country Code Ex SAU | |||||||
zip | string | 32 | Zip Code | |||||||
state | string | 32 | State | |||||||
identity_proof_document | number | string | 20 | An identity number can be any valid id number which is provided by government that may be used to prove a person's identity. | ||||||
type | string | 20 | An identity document's type the expected document types are passport,nationalId,driving licence | |||||||
expiry_date | string | 10 | The identity document's expiry date the format should be - YYYY-MM-DD | |||||||
supplementary_documents | number | string | 20 | Supplemental documents are supporting materials | ||||||
type | string | 20 | Supplemental documents are supporting materials | |||||||
expiry_date | string | 10 | YYYY-MM-DD | |||||||
employment_details | employer_name | string | 64 | Company Name of the client | ||||||
income | string | 64 | Income of the client | |||||||
occupation | string | 64 | Occupation/Trade | |||||||
custom_fields | key | string | 20 | Custom Tag. Ex: client_type | ||||||
value | string | 128 | Tag 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 |
---|---|
200 | Sample Description |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
502 | Bad gateway |
503 | Scheduled Maintenance |
504 | Gateway Timeout |
596 | Service Not Found |