Debit Solutions

Overview

Our one-stop, centralised solution for Debit Card processing is designed to provide you with a seamless and secure payment experience. Whether you are a small business or a large enterprise, our solution is cost-effective, easily configurable and scalable to meet your specific needs.

With our Debit Card processing solution, you can easily accept payments from your customers and enjoy faster access to your funds. Our platform supports all major debit card networks, so you can accept payments from customers regardless of their bank.

Activate Debit cards

Users can activate debit 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 debit card in real-time or on a scheduled basis.

View transaction history

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

Reload cards

Users can add funds to a debit 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 debit card transactions.

Protect against fraud

Users can access measures to detect and prevent fraudulent activity on debit cards, such as monitoring for suspicious activity or requiring additional authentication for certain transactions.

Manage card accounts

Users can view and manage their debit 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.

Card Direct Debit(Post)

This API retrieves direct debit details of specific account details.

Card Direct Debit Update(Post)

This API receives updates on direct debit details of specific accounts used by the bank.

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.

Account Transfer(Post)

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

Get Eligible Transactions(Post)

This API retrieves a list of transactions that qualify for conversion into an installment plan.

Refinance Transaction(Post)

This API allows the conversion of a specific transaction into an installment plan.

Get Plan List(Post)

This API allows fetching the list of active instalment plans.

Get Plan Details ById(Post)

This API allows fetching all the details related to active instalment plan.

Card Contact Details(Post)

This API allows fetching the customer contact details.

Account Create

Status:

Production

Version:

V2

Product:

Credit Solutions

Account Create

Overview

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. These custom fields allow for the addition of unique information, such as contract numbers. Once the parameters are set, the API executes the creation of the new account and returns a response indicating the success or failure of the process.

Easy Customer Onboarding

Streamline the process of creating new accounts with the ability to assign a unique customer ID and customizable product code.

Multi-Currency Support

Enable account creation in various currencies, such as SAR, AED, and USD.

Custom Field Options

Offer flexibility with custom fields for additional account details, such as contract ID or other relevant information.

How It Works

The Account Create API enables the creation of new accounts for customers using specific parameters such as customer ID, card type, branch code, product code, currency, and custom fields. Once the parameters are set, the API executes the creation of the account and returns a response indicating the success or failure of the account creation. The API helps to automate the process of account creation, making it faster and more efficient for businesses. It also ensures that the created account meets the specified parameters, reducing the risk of errors and inconsistencies.
To create multi-currency top wallet you will need to provide the related product code, and you will have the option to list the needed wallet currencies, this can be achieved by sending key CN-WALLET_LIST under custom_fields and the list of currencies as a value comma separated string example: AED,USD.

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 “TRANSACTION”
	msg_function* required			string	50	Message functions: Should be “REQ_ACCOUNT_CREATE”
	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	Customer ID: Customer Identification number This should be a unique number
	card_type* required			string	7	Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT
	account	customer_id* required		string	20	Customer ID: Customer Identification number This should be a unique number
		account_number		string	64	Account number, if not provided CMS will generate it
		parent_account_number		string	64	Parent account number - Applicable only for Corporate products
		branch_code* required		string	10	Branch Code, if no branches are used, the code must be same as bank_code
		product_code* required		string	32	Product code, this code is generated by CMS after creating the product, this code is FI spesific code 982_AED_002_A is just used as an example in Sandbox
		billing_day		string	10	Billing date, applicable only for credit card products
		currency* required		string	3	Informative value to the request, does not have any functional impact, the currency will be taken from the product
		limit	type	string	32	Credit limit type - applicable only for credit card products
			currency	string	3	Credit limit currency - applicable only for credit card products
			value	string	20	Credit limit value - applicable only for credit card products
		custom_fields	key	string	20	Custom Tag. Ex: contract_idt_scheme
		custom_fields	value	string	128	Tag value. Ex: CONTRACT_NUMBER

{"NISrvRequest":{"request_account_create":{"header":{"msg_id":"920197","msg_type":"TRANSACTION","msg_function":"REQ_ACCOUNT_CREATE","src_application":"IVR","target_application":"WAY4","timestamp":"2020-07-20T10:49:02.366+04:00","bank_id":"NIC"},"body":{"customer_id":"100000027","card_type":"CREDIT","account":{"customer_id":"100000027","branch_code":"982","product_code":"982_AED_042_A","currency":"AED","limit":{"type":"FIN_LIMIT","value":"55000"},"custom_fields":[{"key":"contract_idt_scheme","value":"CONTRACT_NUMBER"}]}}}}}

{
    "NISrvRequest": {
        "request_account_create": {
            "header": {
                "msg_id": "920197",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_ACCOUNT_CREATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "customer_id": "100000027",
                "card_type": "CREDIT",
                "account": {
                    "customer_id": "100000027",
                    "branch_code": "982",
                    "product_code": "982_AED_042_A",
                    "currency": "AED",
                    "limit": {
                        "type": "FIN_LIMIT",
                        "value": "55000"
                    },
                    "custom_fields": [
                        {
                            "key": "contract_idt_scheme",
                            "value": "CONTRACT_NUMBER"
                        }
                    ]
                }
            }
        }
    }
}

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 “TRANSACTION”
	msg_function* required		string	50	Message functions: Should be “REP_ACCOUNT_CREATE”
	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 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	account_number* required		string	64	Account number
	custom_fields	key	string	20	Custom Tag. Ex: contract_idt_scheme
	custom_fields	value	string	128	Tag value. Ex: CONTRACT_NUMBER

{"NISrvResponse":{"response_account_create":{"header":{"msg_id":"920197","msg_type":"TRANSACTION","msg_function":"REP_ACCOUNT_CREATE","src_application":"IVR","target_application":"WAY4","timestamp":"2024-02-15T15:30:56.589+04:00","bank_id":"NIC"},"exception_details":{"application_name":"TCC-ADP","date_time":"2024-02-15T15:30:56.589+04:00","status":"S","error_code":"000","error_description":"Success"},"body":{"account_number":"0009821110000000055","custom_fields":[{"key":"CN-AECB_STATUS_TYPE","value":"_"},{"key":"CN-AMF_WAIVER_A","value":"N"},{"key":"CN-BC_A1","value":"_"},{"key":"CN-BC_A2","value":"_"},{"key":"CN-CARD_TARIFF","value":"PCT_003"},{"key":"CN-CONTRACT_NAME","value":"Robert James"},{"key":"CN-CREDIT_LIMIT_AM","value":"55000"},{"key":"CN-CRLIM_MAX_IGNORE_PE","value":"N"},{"key":"CN-DATE_OPEN","value":"2025-01-01"},{"key":"CN-DD_DAY","value":"0"},{"key":"CN-DD_ENROLMENT","value":"N"},{"key":"CN-DD_PCNT","value":"0"},{"key":"CN-INS_ENROLMENT-01","value":"_"},{"key":"CN-INS_ENROLMENT-02","value":"_"},{"key":"CN-INS_ENROLMENT-03","value":"_"},{"key":"CN-INS_ENROLMENT-04","value":"_"},{"key":"CN-INS_ENROLMENT-05","value":"_"},{"key":"CN-INS_ENROLMENT-06","value":"_"},{"key":"CN-INS_ENROLMENT-07","value":"_"},{"key":"CN-INS_ENROLMENT-08","value":"_"},{"key":"CN-INS_ENROLMENT-09","value":"_"},{"key":"CN-INS_ENROLMENT-10","value":"_"},{"key":"CN-INS_ENROLMENT-11","value":"_"},{"key":"CN-INS_ENROLMENT-12","value":"_"},{"key":"CN-INTEREST_WAIVER","value":"N"},{"key":"CN-LPF_WAIVER","value":"N"},{"key":"CN-LTY_ACCR_WAIVER","value":"Y"},{"key":"CN-LTY_ENROLMENT","value":"N"},{"key":"CN-MMF_WAIVER_A","value":"N"},{"key":"CN-MTP_FLAG","value":"N"},{"key":"CN-OVL_WAIVER","value":"N"},{"key":"CN-SAV_ACC_AM","value":"0"},{"key":"CN-SCORE_LIMIT","value":"0"},{"key":"CN-SCORE_LIMIT_APPR","value":"0"},{"key":"CN-SCORE_VAL","value":"0"},{"key":"CN-SEC_CH_AM","value":"0"},{"key":"CN-SMS_ENROLMENT","value":"Y"},{"key":"CN-STMT_FEE_WAIVE_PERS","value":"N"},{"key":"CN-STMT_FLAG_PE","value":"B"},{"key":"CN-TEMP_CREDIT_LIMIT_AM","value":"0"}]}}}}

{
    "NISrvResponse": {
        "response_account_create": {
            "header": {
                "msg_id": "920197",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_ACCOUNT_CREATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2024-02-15T15:30:56.589+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-02-15T15:30:56.589+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "account_number": "0009821110000000055",
                "custom_fields": [
                    {
                        "key": "CN-AECB_STATUS_TYPE",
                        "value": "_"
                    },
                    {
                        "key": "CN-AMF_WAIVER_A",
                        "value": "N"
                    },
                    {
                        "key": "CN-BC_A1",
                        "value": "_"
                    },
                    {
                        "key": "CN-BC_A2",
                        "value": "_"
                    },
                    {
                        "key": "CN-CARD_TARIFF",
                        "value": "PCT_003"
                    },
                    {
                        "key": "CN-CONTRACT_NAME",
                        "value": "Robert James"
                    },
                    {
                        "key": "CN-CREDIT_LIMIT_AM",
                        "value": "55000"
                    },
                    {
                        "key": "CN-CRLIM_MAX_IGNORE_PE",
                        "value": "N"
                    },
                    {
                        "key": "CN-DATE_OPEN",
                        "value": "2025-01-01"
                    },
                    {
                        "key": "CN-DD_DAY",
                        "value": "0"
                    },
                    {
                        "key": "CN-DD_ENROLMENT",
                        "value": "N"
                    },
                    {
                        "key": "CN-DD_PCNT",
                        "value": "0"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-01",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-02",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-03",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-04",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-05",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-06",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-07",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-08",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-09",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-10",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-11",
                        "value": "_"
                    },
                    {
                        "key": "CN-INS_ENROLMENT-12",
                        "value": "_"
                    },
                    {
                        "key": "CN-INTEREST_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-LPF_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-LTY_ACCR_WAIVER",
                        "value": "Y"
                    },
                    {
                        "key": "CN-LTY_ENROLMENT",
                        "value": "N"
                    },
                    {
                        "key": "CN-MMF_WAIVER_A",
                        "value": "N"
                    },
                    {
                        "key": "CN-MTP_FLAG",
                        "value": "N"
                    },
                    {
                        "key": "CN-OVL_WAIVER",
                        "value": "N"
                    },
                    {
                        "key": "CN-SAV_ACC_AM",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_LIMIT",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_LIMIT_APPR",
                        "value": "0"
                    },
                    {
                        "key": "CN-SCORE_VAL",
                        "value": "0"
                    },
                    {
                        "key": "CN-SEC_CH_AM",
                        "value": "0"
                    },
                    {
                        "key": "CN-SMS_ENROLMENT",
                        "value": "Y"
                    },
                    {
                        "key": "CN-STMT_FEE_WAIVE_PERS",
                        "value": "N"
                    },
                    {
                        "key": "CN-STMT_FLAG_PE",
                        "value": "B"
                    },
                    {
                        "key": "CN-TEMP_CREDIT_LIMIT_AM",
                        "value": "0"
                    }
                ]
            }
        }
    }
}

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