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.

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 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.

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.

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 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.

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.

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.

Bulk Card Summary

Status:

Production

Version:

V2

Product:

Debit Solutions

Overview

Bulk Card Summary can be used for stock management, this will give you statistics of your stock. For example you will be able to know the number of cards available under a given product.

client_number: client number used in the bulk card create request
product_code: specific product code
countr_status_code: card status (statuses described in bulk card create)
appl_reg_number: Unique request identifier that we will return as part of the card create response.
batch_idt: batch idt used in the bulk card create request
card_identifier_id: option to filter by specific card or EXID

How It Works

You can retrieve the bulk card summary, filtering by.

There are four statuses for cards:

client_number: client number used in the bulk card create request.
product_code: specific product code.
countr_status_code: card status (statuses described in bulk card create)

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_bulk_card_summary	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_BULK_CARD_SUMMARY”
			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	product_code	string	50	Product Code
			product_code_tgt	string	50	Code of the client card-level product for which this bulk card is suitable
			client_number	string	20	Client number/Customer Id or CIF the card will be created under it
			contr_status_code	string	32	Status of the card in the bulk batch

{"NISrvRequest":{"request_bulk_card_summary":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"REQ_BULK_CARD_SUMMARY","src_application":"BNK","target_application":"WAY4","timestamp":"2020-07-20T10:49:02.366+04:00","bank_id":"NIC"},"body":{"product_code":"982_AED_001_BULK","product_code_tgt":"982_AED_001","client_number":"112233719988744606","contr_status_code":"BULK_IN_PROGRESS"}}}}

{
    "NISrvRequest": {
        "request_bulk_card_summary": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_BULK_CARD_SUMMARY",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "product_code": "982_AED_001_BULK",
                "product_code_tgt": "982_AED_001",
                "client_number": "112233719988744606",
                "contr_status_code": "BULK_IN_PROGRESS"
            }
        }
    }
}

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

Node Type					Type	Length	Description
NISrvResponse	response_bulk_card_summary	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_BULK_CARD_SUMMARY”
			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	summary	product_code* required	string	50	Product code
				product_name* required	string	100	Product name
				client_number	string	20	Client number/Customer Id or CIF linked to the card
				client_short_name	string	255	Client short name
				contr_status_code* required	string	32	Status of the card in the bulk batch
				production_status* required	string	1	Card production status, M: Marked for embossing, L: Locked
				number_of_cards* required	string	4	Number of cards

{"NISrvResponse":{"response_bulk_card_summary":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"REP_BULK_CARD_SUMMARY","src_application":"IVR","target_application":"WAY4","timestamp":"2020-07-20T10:49:02.366+04:00","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":{"summary":[{"product_code":"982_AED_001_BULK","product_name":"982-PS AED Visa Classic - Bulk","client_number":"112233719988744606","client_short_name":"NI","contr_status_code":"BULK_IN_PROGRESS","production_status":"M","number_of_cards":"10"}]}}}}

{
    "NISrvResponse": {
        "response_bulk_card_summary": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_BULK_CARD_SUMMARY",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "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": {
                "summary": [
                    {
                        "product_code": "982_AED_001_BULK",
                        "product_name": "982-PS AED Visa Classic - Bulk",
                        "client_number": "112233719988744606",
                        "client_short_name": "NI",
                        "contr_status_code": "BULK_IN_PROGRESS",
                        "production_status": "M",
                        "number_of_cards": "10"
                    }
                ]
            }
        }
    }
}

Node	Child Node			Type	Length	Description

Code	Description
*	*

Debit Solutions

Credit Solutions

Overview

Activate prepaid cards

Check card balances

View transaction history

Reload cards

Resolve disputes

Protect against fraud

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 Status Change(Post)

Card Replacement(Post)

Client Update(Post)

Account Update(Post)

Card Update(Post)

Get Limits(Post)

Switch Restrictions(Post)

Update Limits(Post)

Get Restrictions(Post)

Bulk Card Create(Post)

Bulk List Of Cards(Post)

Bulk Card Summary(Post)

Bulk Move Cards(Post)

OnlineEmbossing(Post)

Account Status Change(Post)

Switch MCC(Post)

Release Pending Authorization(Post)

Get MCC Controls(Post)

Get Account Transactions(Post)

Get Dictionaries MCC(Post)

Set FXRates(Post)

Get FXRates(Post)

Card Contact Details(Post)

Bulk Card Summary

Status:

Production

Version:

V2

Product:

Debit Solutions

Overview

How It Works

Bulk Card Summary

Status:

Production

Version:

V2

Product:

Debit Solutions

Header Request Parameters

Request Parameters

Sample Request

Header Response parameters

Response parameters

Sample Response

Error Code

Appendix