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.

P2P Transfer

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Overview

The P2P Transfer API facilitates the movement of funds from a source (either an account or a card) to a target (either an account or a card). This operation involves debiting the specified "source identifier" and crediting the designated "target identifier" with the requested amount, all within the same financial institution (FI).

The transfer scenarios covered include:

From a Card identifier to another Card identifier
From a Card identifier to an Account identifier
From an Account identifier to a Card identifier
From an Account identifier to another Account identifier

This API is particularly useful for transferring funds within a corporate product hierarchy, enabling transfers between various levels such as from a company to a department. It also facilitates transfers between two distinct private accounts or cards.

How It Works

The P2P Transfer API functions by providing the source and target IDs in the transfer request, along with the specified amount. This initiates the transfer of funds from the source ID to the target ID.

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_P2P_transfer	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	Static Value - REQ_P2P_TRANSFER
			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	source_identifier_id* required			string	32	source identifier
			source_identifier_type* required			string	20	CONTRACT_NUMBER or EXID
			target_identifier_id* required			string	32	target identifier
			target_identifier_type* required			string	20	CONTRACT_NUMBER or EXID
			transaction	transaction_code* required		string	32	Transaction code For Payment- PAYCC For Reversal- PAYACC-REV For Debit- DEBITCC For Debit Reversal- DEBITCC-REV
				amount* required		string	20	Amount
				currency* required		string	3	Currency
				description		string	255	Transaction description
				billing_amount		string	20	Billing Amount
				billing_currency		string	3	Billing Currency
				auth_code		string	6	Auth Code
				country		string	3	Country
				city		string	200	City
				counter_party_number		string	20	Source Number
				transaction_ref_number* required		string	12	Transaction reference number
				transaction_date		string	19	Date of transactions
				external_ref_number		string	12	Reference number
				transfer_network		string	40	Network
				rules_data	key	string	32	Custom Tag
				rules_data	value	string	128	Tag value

{"NISrvRequest":{"request_p_2_p_transfer":{"header":{"msg_id":"6546126","msg_type":"TRANSACTION","msg_function":"REQ_P2P_TRANSFER","src_application":"BNK","target_application":"w4ksa04","timestamp":"2023-03-09T12:03:01.609+04:00","tracking_id":"Rq_p2ptfr7","bank_id":"PRMBK"},"body":{"source_identifier_type":"EXID","source_identifier_id":"0003666048844670682","target_identifier_type":"EXID","target_identifier_id":"0003666048844670840","transaction":{"transaction_code":"PT-NQ-OP-P2P","transaction_date":"2021-01-15 16:26:36.112","amount":"1000.00","currency":"SAR","billing_amount":"1000.00","billing_currency":"USD","description":"account Payment","transaction_ref_number":"7811841231","auth_code":"123456","country":"UAE","city":"Dubai","external_ref_number":"","transfer_network":"fi\/hierarchy\/network_code","rules_data":[{"key":"src_app_code","value":"X"},{"key":"ext_user_id","value":"Y"}]}}}}}

{
    "NISrvRequest": {
        "request_p_2_p_transfer": {
            "header": {
                "msg_id": "6546126",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_P2P_TRANSFER",
                "src_application": "BNK",
                "target_application": "w4ksa04",
                "timestamp": "2023-03-09T12:03:01.609+04:00",
                "tracking_id": "Rq_p2ptfr7",
                "bank_id": "PRMBK"
            },
            "body": {
                "source_identifier_type": "EXID",
                "source_identifier_id": "0003666048844670682",
                "target_identifier_type": "EXID",
                "target_identifier_id": "0003666048844670840",
                "transaction": {
                    "transaction_code": "PT-NQ-OP-P2P",
                    "transaction_date": "2021-01-15 16:26:36.112",
                    "amount": "1000.00",
                    "currency": "SAR",
                    "billing_amount": "1000.00",
                    "billing_currency": "USD",
                    "description": "account Payment",
                    "transaction_ref_number": "7811841231",
                    "auth_code": "123456",
                    "country": "UAE",
                    "city": "Dubai",
                    "external_ref_number": "",
                    "transfer_network": "fi/hierarchy/network_code",
                    "rules_data": [
                        {
                            "key": "src_app_code",
                            "value": "X"
                        },
                        {
                            "key": "ext_user_id",
                            "value": "Y"
                        }
                    ]
                }
            }
        }
    }
}

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

Node Type					Type	Length	Description
NISrvResponse	response_P2P_transfer	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 “TRANSACTION”
			msg_function* required		string	50	Default REP_P2P_TRANSFER
			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	tranCode* required		string	3	The transaction code. 101 for auth; 102 for advice; 108 for profile maturation
			source* required		string	10	Name of source application.
			dest* required		string	20	Name of destination application.
			extendedHeader* required		string	10	Extended header.
			response_record_version* required		string	1	The response_record_version specifies the version of the scoring response layout.
			score_count* required		string	2	The number of scores in the response message and has values from 0 to 8.
			decision_count* required		string	2	The number of decisions in the response message and has values from 0 to 10.
			scoring_server_id* required		string	4	unique identifier for the Scoring Server host.
			warning		string	50	warning
			decisions	decision_type* required	string	32	Stores the decision type of a type/code pair created by Falcon Rule Expert functions that generate type/code pairs
			decisions	decision_code* required	string	32	Stores the decision code of a type/code
			scores	score* required	string	4	the score returned from the model
				error_code* required	string	4	This is the error code generated by the model during its processing of the transaction to generate a score. A value of 0 or blank indicates no error.
				segment_ID* required	string	8	This field contains the segment ID of the score in the score_1 field
				score_name* required	string	22	Identifier for the score.
				reason_1* required	string	4	Reason the score was generated
				reason_2* required	string	4	Reason the score was generated
				reason_3* required	string	4	Reason the score was generated

{"NISrvResponse":{"response_P2P_transfer":{"header":{"msg_id":"236001","msg_type":"TRANSACTION","msg_function":"REP_P2P_TRANSFER","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":{"tranCode":"999","source":"","dest":"","extendedHeader":"","response_record_version":"","score_count":"","decision_count":"","scoring_server_id":"","warning":"","decisions":{"decision_type":"","decision_code":""},"scores":{"score":"9999","error_code":"","segment_ID":"","score_name":"","reason_1":"","reason_2":"","reason_3":""}}}}}

{
    "NISrvResponse": {
        "response_P2P_transfer": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_P2P_TRANSFER",
                "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": {
                "tranCode": "999",
                "source": "",
                "dest": "",
                "extendedHeader": "",
                "response_record_version": "",
                "score_count": "",
                "decision_count": "",
                "scoring_server_id": "",
                "warning": "",
                "decisions": {
                    "decision_type": "",
                    "decision_code": ""
                },
                "scores": {
                    "score": "9999",
                    "error_code": "",
                    "segment_ID": "",
                    "score_name": "",
                    "reason_1": "",
                    "reason_2": "",
                    "reason_3": ""
                }
            }
        }
    }
}

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)

P2P Transfer

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Overview

How It Works

P2P Transfer

Status:

Production

Version:

V2

Product:

Prepaid Solutions

Header Request Parameters

Request Parameters

Sample Request

Header Response parameters

Response parameters

Sample Response

Error Code