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.

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.

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.

Download

Client Create(Post)

This API is used to create a new cardholder within a financial institution. It can be used to register a new customer and issue them with a card.

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.

Card Create(Post)

A card creation API in a payment processing company allows users to add a credit or debit card to their account on the payment platform.

Card Activate(Post)

This API is used for activating newly issued cards or ones that have been renewed. Enables transactions on a new or replaced card by activating it.

Card Set Pin(Post)

This API enables the setting of a personal identification number (PIN) for a specific card, which can then be used for point of sale or ATM transactions.

Card Pin Verification(Post)

This API is used to check if a PIN provided by the cardholder matches the one associated with the card, in order to confirm the identity of the cardholder.

Card Pin Change(Post)

This API allows a cardholder to change their PIN by verifying their current PIN and setting a new one. The new PIN will be used for Point of Sales or ATM transactions.

Pin Tries Counter Reset(Post)

This API allows to reset the number of attempts a user has made to enter the correct PIN, in case the user has entered the incorrect PIN multiple times.

Get CVV2(Post)

This API allows consumers to retrieve the CVV2 (Card Verification Value 2) for a specific card.

Lookup Card Identifier(Post)

This API allows you to obtain an alternative identifier for a given card by using its identifier as input, the API will then return a different type of identifier such as tokenized card identifier.

Cards List(Post)

This API obtains a comprehensive listing of all the cards linked to a specific cardholder, including prepaid, credit, and debit cards.

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.

Card Details Enquiry(Post)

This API is used to retrieve information about a specific card such as the primary account number, the product the card is associated with, the status of the card, and any balances associated with the card.

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.

Card Transaction(Post)

This API posts a financial transactions on card or account by debiting or crediting the account balance with provided amount and currency.

Card Statement Summary(Post)

This API is used to Retrieve past transactions made using a specific card.

Card Status Change(Post)

This API is used to change the status of a card or account, such as blocking or unblocking it. It is used primarily for security purposes.

Get Card Transactions(Post)

This API is used to Retrieve past transactions made using a specific card.

Card Replacement(Post)

This API is used to request a new card to replace a lost, stolen, damaged, or expired card.

Client Update(Post)

A client update API in a payment processing company allows users to update information for an existing client account in the payment processing system.

Account Update(Post)

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

Card Update(Post)

The API facilitates the modification of an existing card associated with a specific account and cardholder.

Get Limits(Post)

This API allows customers to easily view a summary of their limit usage, providing a convenient way to keep track of their spending and manage their finances.

Card Balance Enquiry(Post)

Obtains information about the card's available funds and balances related to the product type.

Switch Restrictions(Post)

This API allows customers to seamlessly switch restrictions on their credit or debit cards, helping them to make decisions about their spending.

Update Limits(Post)

This API enables customers to quickly and easily view any limits on their credit or debit cards, helping them to make informed decisions about their spending.

Get Companies(Post)

This API enables customers to Get the details of the companies

Get Restrictions(Post)

This API enables customers to quickly and easily view any restrictions on their credit or debit cards, helping them to make informed decisions about their spending.

Bulk Card Create(Post)

Bulk card create can generate a pool of no-name plastic cards ready for instant issuance.

Bulk List Of Cards(Post)

Bulk list of cards can be used to check the status of bulk card create requests or to access the list of pre-embossed cards.

Bulk Card Summary(Post)

Bulk card summary can be used to check summary of the cards available in stock.

Bulk Move Cards(Post)

Bulk move cards can be used to move card/list of cards or batches from one client to another.

OnlineEmbossing(Post)

This API is used to immediately send a request for card embossing.

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.

Account Transaction(Post)

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

Account Status Change(Post)

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

Switch MCC(Post)

This API enables or disables MCC groups/codes for a card.

Release Pending Authorization(Post)

This API cancels pending authorizations. It will only search for pending authorizations.

Get MCC Controls(Post)

This API retrieves all blocked and/or allowed MCC groups and codes.

Account Balance Enquiry(Post)

The Account Balance API receives balance details of account numbers.

Account Hierarchy Enquiry(Post)

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

Get Account Transactions(Post)

This API pulls transactions which are authorized, time_based/posted, or statemented to account.

Get Dictionaries MCC(Post)

This API retrieves all blocked and/or allowed MCC groups and codes.

Set FXRates(Post)

This service is used by an FI to set FX rates for a currency.

Get FXRates(Post)

This service is used by an FI to get FX rates for a currency.

Card Contact Details(Post)

This API allows fetching the customer contact details.

Customer Details

Status:

Production

Version:

V2

Product:

Prepaid Solutions

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.

Node	Child Node	Type	Length	Description
Authorization* required	Bearer xxxx* required	string		Authorization Header (Bearer Token)
Content-Type* required	application/json* required	string		Content Type

Node Type			Type	Length	Description
header	msg_id* required		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* required		string	12	Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
	msg_function* required		string	50	Message functions: Should be "REQ_GENERIC_CUSTOMER_DETAILS"
	src_application* required		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* required		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* required		string	30	Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
	bank_id* required		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* required		string	20	Either Customer ID or Card Identifier Id
	card_identifier_id		string	32	CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
	card_identifier_type		string	20	CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS.
	additional_qualifiers	type	string	32	Additional 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
	additional_qualifiers	value	string	128	Additional 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"}}}}

{
    "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-Type	application/json					string		Content Type

Node Type			Type	Length	Description
header	msg_id* required		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* required		string	12	Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
	msg_function* required		string	50	Message functions: Should be " REP_GENERIC_CUSTOMER_DETAILS"
	src_application* required		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* required		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* required		string	15	Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
	bank_id* required		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	application_name* required		string	20	Application Name
	date_time* required		string	30	Timestamp of the response Format YYYY-MM-DD HH:MM:SS
	status* required		string	1	Status of the request (S/F)
	error_code* required		string	4	EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
	error_description* required		string	100	Error Description (Check error codes section for the complete list of error codes and error code descriptions)
	transaction_ref_id		string	20	The tracking_id sent in the request will be sent back in response in this field.
body	customer_id* required		string	20	Customer ID: Customer Identification number This should be a unique number
	bank_code* required		string	5	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	Client number Ex: 000003548435901
	card_name* required		string	21	Card embossing name defined on client level (Upper case)
	personal_details	gender	string	6	Gender
		title	string	5	Title
		first_name* required	string	255	First Name
		last_name* required	string	255	Last Name
		middle_name	string	255	Middle_name
		citizenship* required	string	3	citizenship
		marital_status	string	18	Marital status
		date_of_birth* required	string	15	Date of birth
		place_of_birth	string	255	Place of birth
		language	string	3	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 Number
		work_phone	string	32	Mobile Number
		mobile_phone	string	32	Mobile Number
		email	string	255	Email address
	addresses	address_type* required	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* required	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
		email	string	255	Valid email address of the client
		phone	string	32	Phone number
		city* required	string	255	City name
		country* required	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	Client type Tag
	custom_fields	value	string	128	Tag 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"}]}}}}

{
    "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
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

Prepaid Solutions

Prepaid Solutions

Overview

Activate prepaid cards

Check card balances

View transaction history

Reload cards

Resolve disputes

Manage card accounts

Client Create(Post)

Account Create(Post)

Card Create(Post)

Card Activate(Post)

Card Set Pin(Post)

Card Pin Verification(Post)

Card Pin Change(Post)

Pin Tries Counter Reset(Post)

Get CVV2(Post)

Lookup Card Identifier(Post)

Cards List(Post)

Accounts List(Post)

Card Details Enquiry(Post)

Customer Details(Post)

Card Transaction(Post)

Card Statement Summary(Post)

Card Status Change(Post)

Get Card Transactions(Post)

Card Replacement(Post)

Client Update(Post)

Account Update(Post)

Card Update(Post)

Get Limits(Post)

Card Balance Enquiry(Post)

Switch Restrictions(Post)

Update Limits(Post)

Get Companies(Post)

Get Restrictions(Post)

Bulk Card Create(Post)

Bulk List Of Cards(Post)

Bulk Card Summary(Post)

Bulk Move Cards(Post)

OnlineEmbossing(Post)

P2P Transfer(Post)

Account Transaction(Post)

Account Status Change(Post)

Switch MCC(Post)

Release Pending Authorization(Post)

Get MCC Controls(Post)

Account Balance Enquiry(Post)

Account Hierarchy Enquiry(Post)

Get Account Transactions(Post)

Get Dictionaries MCC(Post)

Set FXRates(Post)

Get FXRates(Post)

Card Contact Details(Post)

Customer Details

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Customer Details

Overview

Card information retrieval

Security

How It Works

Process 1

Process 1

Process 1

Customer Details

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Header Request Parameters

Request Parameters

Sample Request