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.

Get Eligible Plans(Post)

The Get Eligible Plans API is a useful tool for payment processing companies that offer credit or debit card services. This API allows customers to easily view a list of plans that they are eligible for, providing a convenient way to compare different plan options and choose the one that best suits their needs.

Balance Transfer(Post)

The Balance Transfer API is a powerful tool for payment processing companies that offer balance transfer services. This API allows customers to easily transfer the balance from one credit card to another, providing a convenient way to manage their finances and pay off debt.

Card Balance Enquiry(Post)

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

LoanOnCall QuickCash(Post)

The Quick Cash API is a powerful tool for payment processing companies that offer loan services. This API allows customers to apply for and receive loans quickly and easily, providing a convenient and hassle-free way to access credit when needed.

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.

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.

Card Contact Details(Post)

This API allows fetching the customer contact details.

Balance Conversion(Post)

IPP Balance Conversion API transaction transfers outstanding principal amounts from IPP plans to Retail plans. It debits the IPP LOAN UNB bucket and credits the "Retail Instalments (technical)" account, then allocates funds to RETAIL plan LOAN buckets following a priority sequence of BIL_PREV, BIL_LAST, and CUR. This enables efficient balance transfers between payment structures while maintaining systematic allocation priorities.

Get Plan List

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Overview

This API allows fetching the list of active instalment plans that a customer has already converted from their purchases. It allows customers to view all ongoing payment plans, including details such as plan id, due amount, overdue amount, and paid amount. By giving an overview of active plans, the details helps cardholders easily track their financial commitments and manage their Buy Now, Pay Later (BNPL) arrangements effectively. This ensures cardholders stay informed about their current financial obligations and enabling smoother financial management.

How It Works

When a customer converts transactions or balances into an instalment plan, they typically want to view their active plans along with important details for each one. This API is designed to provide those details, giving customers full visibility into their active instalment plans. TAPI helps ensure customers stay informed and manage their instalment plans more effectively. This level of transparency enhances the customer experience and promotes financial clarity.

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_get_plan_list	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	name to be used Default REQ_GET_PLAN_LIST
			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	Target application name Ex WAY4 or DCMS or PCMS
			timestamp* required	string	30	Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
			tracking_id	string	15	Transaction Tracking Id
			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”
			instance_id	string	10	instance_id
		body	card_identifier_id* required	string	32	card identifier
		body	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

{"NISrvRequest":{"request_get_plan_list":{"header":{"msg_id":"6754839045","msg_type":"{{msg_type_E}}","msg_function":"REQ_GET_PLAN_LIST","src_application":"SIT42","target_application":"WAY4","timestamp":"{{timestamp1}}","tracking_id":"{{$randomInt}}","bank_id":"NIC"},"body":{"card_identifier_id":"5366532001320497","card_identifier_type":"CONTRACT_NUMBER"}}}}

{
    "NISrvRequest": {
        "request_get_plan_list": {
            "header": {
                "msg_id": "6754839045",
                "msg_type": "{{msg_type_E}}",
                "msg_function": "REQ_GET_PLAN_LIST",
                "src_application": "SIT42",
                "target_application": "WAY4",
                "timestamp": "{{timestamp1}}",
                "tracking_id": "{{$randomInt}}",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "5366532001320497",
                "card_identifier_type": "CONTRACT_NUMBER"
            }
        }
    }
}

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

Node Type					Type	Length	Description
NISrvResponse	response_get_plan_list	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 RES_GET_PLAN_LIST
			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
			tracking_id		string	15	Transaction Tracking Id
			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”
			instance_id		string	10	instance_id
		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	instalments	plan_id	string
				description	string
				plan_number	string
				creation_date	string
				first_payment_date	string
				close_date	string
				currency	string
				total_amount	string
				principal	string
				fee	string
				paid_amount	string
				due_amount	string
				overdue_amount	string
				written_off_amount	string
				portion_total	string
				portion_principal	string
				portion_fee	string

{"NISrvResponse":{"response_get_plan_list":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"RES_GET_PLAN_LIST","src_application":"IVR","tracking_id":"236001","bank_id":"NIC","instance_id":"236001"},"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":{"instalments":[{"plan_id":"string","description":"string","plan_number":"string","creation_date":"string","first_payment_date":"string","close_date":"string","currency":"string","total_amount":"string","principal":"string","fee":"string","paid_amount":"string","due_amount":"string","overdue_amount":"string","written_off_amount":"string","portion_total":"string","portion_principal":"string","portion_fee":"string"}]}}}}

{
    "NISrvResponse": {
        "response_get_plan_list": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "RES_GET_PLAN_LIST",
                "src_application": "IVR",
                "tracking_id": "236001",
                "bank_id": "NIC",
                "instance_id": "236001"
            },
            "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": {
                "instalments": [
                    {
                        "plan_id": "string",
                        "description": "string",
                        "plan_number": "string",
                        "creation_date": "string",
                        "first_payment_date": "string",
                        "close_date": "string",
                        "currency": "string",
                        "total_amount": "string",
                        "principal": "string",
                        "fee": "string",
                        "paid_amount": "string",
                        "due_amount": "string",
                        "overdue_amount": "string",
                        "written_off_amount": "string",
                        "portion_total": "string",
                        "portion_principal": "string",
                        "portion_fee": "string"
                    }
                ]
            }
        }
    }
}

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)

Get Eligible Plans(Post)

Balance Transfer(Post)

Card Balance Enquiry(Post)

LoanOnCall QuickCash(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)

Get Eligible Transactions(Post)

Refinance Transaction(Post)

Get Plan List(Post)

Card Contact Details(Post)

Balance Conversion(Post)

Get Plan List

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Overview

How It Works

Get Plan List

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Header Request Parameters

Request Parameters