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.
Get Eligible Transactions
Status:
Production
Version:
V2
Product:
Debit Solutions
Overview
This API retrieves a list of transactions that qualify for conversion into an installment plan. The eligibility of each transaction is determined based on specific criteria, such as transaction amount, type, and the time frame within which it occurred. This allows users to view which of their past purchases are eligible for installment payments, providing flexibility in managing payments. The API returns details for each transaction, including its ID, amount, and date. This functionality is useful for users looking to convert larger purchases into manageable installments.
How It Works
When offering installment plans to your customers, you have the option to apply them to specific transactions, an eligible balance, or both. To offer this feature on a per-transaction basis, you can use this API to first retrieve a list of transactions that qualify for conversion. Afterward, the client can select the transaction they wish to convert and then use the next API to complete the refinancing process.
Status:
Production
Version:
V2
Product:
Debit Solutions
Node | Child Node | Type | Length | Description |
---|---|---|---|---|
Authorization | Bearer xxxx | string | Authorization Header (Bearer Token) | |
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvRequest | request_get_card_transactions | header | msg_id | 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 | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
msg_function | string | 50 | Message functions: Should be “REQ_GET_CARD_TRANSACTIONS” | |||||||
src_application | 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 | 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 | string | 30 | Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS | |||||||
tracking_id | string | 15 | Transaction Tracking Id | |||||||
bank_id | 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 | string | 32 | Card Identifier | ||||||
card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | |||||||
plan_number | string |
{
"NISrvRequest": {
"request_get_card_transactions": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_GET_CARD_TRANSACTIONS",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+0:00",
"tracking_id": "236001",
"bank_id": "NIC",
"instance_id": "236001"
},
"body": {
"card_identifier_id": "454545XXXXXX1234",
"card_identifier_type": "EXID",
"plan_number": "00166"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_get_card_transactions | header | msg_id | 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 | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
msg_function | string | 50 | Message functions: Should be “REP_GET_CARD_TRANSACTIONS” | |||||||
src_application | 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 | 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 | string | 30 | Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS | |||||||
bank_id | 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 | string | 20 | Application Name | ||||||
date_time | string | 30 | Timestamp of the response Format “YYYY-MM-DD HH:MM:SS” | |||||||
status | string | 1 | Status of the request (S/F) | |||||||
error_code | string | 4 | EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
error_description | 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 | numberOfTransactions | string | 3 | Number of transactions | ||||||
transaction | card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS | ||||||
card_identifier_id | string | 32 | card_identifier_id | |||||||
masked_pan | string | 16 | Pan in Masked form | |||||||
trans_date | string | 10 | Transaction date & the format is DD/MM/YYYY | |||||||
post_date | string | 10 | Posting date & the format is DD/MM/YYYY | |||||||
debit_credit_flag | string | 1 | Type of direction | |||||||
response_code | string | 3 | Return code | |||||||
description | string | 255 | Transaction description | |||||||
transaction_ref_number | string | 12 | Transaction reference number | |||||||
currency | string | 3 | Currency code Ex: AED | |||||||
amount | string | 20 | Amount | |||||||
source_currency | string | 3 | Transaction Currency | |||||||
source_amount | string | 20 | Transaction amount | |||||||
auth_code | string | 32 | Authorization code | |||||||
merchant_id | string | 32 | Merchant ID number | |||||||
merchant_category_code | string | 4 | SIC | |||||||
merchant_name | string | 64 | Merchant Name | |||||||
merchant_address | string | 64 | Merchant Address | |||||||
merchant_city | string | 64 | Merchant City | |||||||
merchant_country | string | 64 | Merchant Country | |||||||
merchant_category_group | string | 20 | Category Group | |||||||
trans_id | string | 20 | Transaction Id | |||||||
balance_type | string | 20 | RETAIL |
{
"NISrvResponse": {
"response_get_card_transactions": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REP_GET_CARD_TRANSACTIONS",
"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": {
"numberOfTransactions": "019",
"transaction": {
"card_identifier_type": "EXID",
"card_identifier_id": "454545XXXXXX1234",
"masked_pan": "454545XXXXXX1234",
"trans_date": "01\/12\/2022",
"post_date": "04\/12\/2022",
"debit_credit_flag": "D",
"response_code": "00",
"description": "",
"transaction_ref_number": "00",
"currency": "AED",
"amount": "210.00",
"source_currency": "AED",
"source_amount": "210.00",
"auth_code": "",
"merchant_id": "",
"merchant_category_code": "",
"merchant_name": "",
"merchant_address": "",
"merchant_city": "",
"merchant_country": "",
"merchant_category_group": "",
"trans_id": "",
"balance_type": ""
}
}
}
}
}
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 |