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.

Cards List

Status:

Production

Version:

V2

Product:

Credit Solutions

List of Cards

Overview

This API enables financial institutions to retrieve a comprehensive list of all cards associated with a specific cardholder, regardless of the card product type (Prepaid, Credit, or Debit). This API is an essential component of Mobile Banking or Home Banking applications, allowing institutions to input a client ID or account ID and retrieve all associated cards. The API response includes key information such as the masked PAN, expiration date, card product details, and status of each card.

Single API for all card types:

The API provides an overview of all card types across different product types, making it easy to manage and access data for multiple card types in one place.

Dashboard for customer channels or CRM applications:

The API allows for the creation of a landing page dashboard for customer channels or CRM applications, providing a centralized location for cardholders to access and manage their card information.

Use case flexibility:

The API allows for a variety of use cases, such as card activation, block/unblock, and transaction history, giving cardholders the ability to manage their cards in a variety of ways.

How It Works

This API allows for the retrieval of all cards associated with a specific cardholder, using a provided customer identifier. The returned list includes all cards, regardless of their status or expiration date, allowing the consumer of the API to implement their own filtering within their application. If a card has been renewed, expired versions will not be included in the list, but instead the newest version will be retrieved.

Additionally, the API provides a list of statuses for each card, such as account status, card status, and plastic status, which can be used to determine cardholder actions such as activation or blocking/unblocking.

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
NISrvRequest	request_list_of_cards	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	Static Value - REQ_LIST_OF_CARDS
			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 account_number has to be sent
			account_number	string	64	Account number
			card_type* required	string	20	Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT

{"NISrvRequest":{"request_list_of_cards":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"REQ_LIST_OF_CARDS","src_application":"IVR","target_application":"WAY4","timestamp":"2020-07-20T10:49:02.366+04:00","bank_id":"NIC"},"body":{"customer_id":"100000027","account_number":"0009821110000000049","card_type":"CREDIT"}}}}

{
    "NISrvRequest": {
        "request_list_of_cards": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_LIST_OF_CARDS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "customer_id": "100000027",
                "account_number": "0009821110000000049",
                "card_type": "CREDIT"
            }
        }
    }
}

Node	Child Node		Type	Length	Description
Content-Type	application/json		string		Content Type

Node Type						Type	Length	Description
NISrvResponse	response_list_of_cards	header	msg_id* required			string	12	Unique Source Message ID eg ada123456fdsf
			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	Default REP_LIST_OF_CARDS
			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 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”
		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	Either cusomer_id or account_number
			account_number* required			string	64	Account number
			cards	card_identifier_id* required		string	32	Card Identifier Id
				card_identifier_type* required		string	20	CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
				contract_name		string	100	Contract name
				masked_pan* required		string	16	Masked PAN
				rbs_number		string	64	RBS is Core banking system number
				card_display_name* required		string	50	Embossed Name
				CIF_number* required		string	20	CIF Number
				card_expiry_date* required		string	4	YYMM Ex 2310
				card_role* required		string	1	Card Role Primary/Supplementary
				account_number* required		string	64	Account number
				product_code* required		string	32	Product code
				product_group		string	32	Product Group
				product_short_code		string	32	Product short code
				product_name		string	32	Product name
				card_brand		string	32	Card brand
				card_virtual_indicator* required		string	1	P/V
				current_pin_attempt		string	3	Current pin attempt
				max_pin_attempt		string	3	Max pin attempt
				set_pin_indicator		string	3	Additional flag to identify if PIN set was done
				statuses	type	string	10	Status type
					value	string	10	Status value
					changed_date	string	10	Date of status change
					description	string	100	Brief description
					contract_role	string	3	Role of top contract
				balances	type* required	string	32	Balance type
					currency* required	string	5	Currency
					amount	string	20	Balance Amount
				custom_fields	key	string	128	Client type Tag
				custom_fields	value	string	128	Tag value

{"NISrvResponse":{"response_list_of_cards":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"REP_LIST_OF_CARDS","src_application":"IVR","target_application":"WAY4","timestamp":"2020-07-20T06:49:02.366Z","bank_id":"NIC"},"exception_details":{"application_name":"TCC-ADP","date_time":"2023-02-01T16:39:47.314+04:00","status":"S","error_code":"000","error_description":"Success","transaction_ref_id":"236001"},"body":{"customer_id":"100000027","account_number":"0009821110000000049","cards":[{"card_identifier_id":"99984100130233802017","card_identifier_type":"EXID","contract_name":"999841XXXXXX3382","masked_pan":"999841XXXXXX3382","rbs_number":"123456789","card_display_name":"JOHN DOE","CIF_number":"100000027","card_expiry_date":"3001","card_role":"P","account_number":"0009821110000000049","product_code":"982_AED_002_P","product_group":"","product_short_code":"","product_name":"","card_brand":"","card_virtual_indicator":"V","current_pin_attempt":"","max_pin_attempt":"","set_pin_indicator":"","statuses":[{"type":"BCC-CARD-982","value":"_","changed_date":"","description":"SPACE","contract_role":""}],"balances":[{"type":"AVAILABLE","currency":"AED","amount":"55000"}],"custom_fields":[{"key":"","value":""}]}]}}}}

{
    "NISrvResponse": {
        "response_list_of_cards": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_LIST_OF_CARDS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T06:49:02.366Z",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-01T16:39:47.314+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "236001"
            },
            "body": {
                "customer_id": "100000027",
                "account_number": "0009821110000000049",
                "cards": [
                    {
                        "card_identifier_id": "99984100130233802017",
                        "card_identifier_type": "EXID",
                        "contract_name": "999841XXXXXX3382",
                        "masked_pan": "999841XXXXXX3382",
                        "rbs_number": "123456789",
                        "card_display_name": "JOHN DOE",
                        "CIF_number": "100000027",
                        "card_expiry_date": "3001",
                        "card_role": "P",
                        "account_number": "0009821110000000049",
                        "product_code": "982_AED_002_P",
                        "product_group": "",
                        "product_short_code": "",
                        "product_name": "",
                        "card_brand": "",
                        "card_virtual_indicator": "V",
                        "current_pin_attempt": "",
                        "max_pin_attempt": "",
                        "set_pin_indicator": "",
                        "statuses": [
                            {
                                "type": "BCC-CARD-982",
                                "value": "_",
                                "changed_date": "",
                                "description": "SPACE",
                                "contract_role": ""
                            }
                        ],
                        "balances": [
                            {
                                "type": "AVAILABLE",
                                "currency": "AED",
                                "amount": "55000"
                            }
                        ],
                        "custom_fields": [
                            {
                                "key": "",
                                "value": ""
                            }
                        ]
                    }
                ]
            }
        }
    }
}

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