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:

Version

Get Account Transactions

Status:

Production

Version:

V2

Product:

Debit Solutions

Overview

Account Transaction Details are designed to give businesses access to granular information about individual transactions associated with specific accounts. This API enables the retrieval of comprehensive details for each transaction, including timestamps, transaction types, amounts, and involved parties. By leveraging this API, businesses can streamline financial analysis, reconcile accounts efficiently, and gain valuable insights into transactional patterns and trends.

How It Works

The Account Transaction Details API functions by sending the account ID, transaction type, and dates as parameters. With this information, the API retrieves all related transaction details for the specified account and provides them in the API response.

/AccountServices/Enquiry/V2/GetAccountTransactions

Get Account Transactions

Status:

Production

Version:

V2

Product:

Debit Solutions
/AccountServices/Enquiry/V2/GetAccountTransactions
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_get_account_transactionsheadermsg_id* requiredstring12Message 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* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REQ_GET_ACCOUNT_TRANSACTIONS”
src_application* requiredstring10Source 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* requiredstring10The 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* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank 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”
bodyaccount_identifier_id* requiredstring32Account Identifier
account_identifier_type* requiredstring20CONTRACT_NUMBER/RBS_NUMBER
transaction_type* requiredstring16authorized, time_based/posted, statemented
date_fromstring10Format DD/MM/YYYY. Maximum interval is 90days. Conditional for posted.
date_tostring10Format DD/MM/YYYY. Maximum interval is 90days.Conditional for posted
statement_periodstring4Format YYMM (Maximum statement is 12 months from the current date).
no_of_transactions_requestedstring2Maximum number of transactions to be fetched in a request. Value should be between 1 and 99 default is 50
requested_page_nostring4Page number of the current request, could be from 1 to 99.
return_mcc_groupstring4To retrun MCC group
condition_filterstring255Filter for aggregate transactions

{
    "NISrvRequest": {
        "request_get_account_transactions": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GET_ACCOUNT_TRANSACTIONS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "account_identifier_id": "454545XXXXXX1234",
                "account_identifier_type": "CONTRACT_NUMBER/RBS_NUMBER",
                "transaction_type": "posted",
                "date_from": "01/12/2022",
                "date_to": "29/12/2022",
                "statement_period": "0123",
                "no_of_transactions_requested": "55",
                "requested_page_no": "55",
                "return_mcc_group": "true"
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_get_account_transactionsheadermsg_id* requiredstring12Message 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* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
msg_function* requiredstring50Message functions: Should be “REP_GET_CARD_TRANSACTIONS”
src_application* requiredstring10Source 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* requiredstring10The 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* requiredstring30Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4Bank 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_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format “YYYY-MM-DD HH:MM:SS”
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.
bodyaccount_identifier_id* requiredstring32Account identifier
account_identifier_type* requiredstring20CONTRACT_NUMBER or EXID
transaction_type* requiredstring16Type of the Account transaction the expected values are - authorized, time_based/posted, statemented
date_fromstring10Format YYYY-MM-DD Conditional for posted
date_tostring10Format YYYY-MM-DD Conditional for posted
statement_periodstring4Format YYMM Conditional Mandatory for statemented
no_of_transactions_returned* requiredstring3Number of transactions
no_of_transactions_requestedstring2Maximum number of transactions to be fetched in a request. Value should be between 1 and 99 default is 50
requested_page_nostring4Page number of the current request, could be from 1 to 99.
total_no_of_pagesstring2Total number of requests
condition_filterstring255Condition_filter provided in request
transactioncard_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
card_identifier_id* requiredstring32card_identifier_id
masked_pan* requiredstring16Pan in Masked form
trans_date* requiredstring10Transaction date & the format is DD/MM/YYYY
post_date* requiredstring10Posting date & the format is DD/MM/YYYY
debit_credit_flag* requiredstring1Type of direction
response_code* requiredstring3Return code
description* requiredstring255Transaction description
transaction_ref_number* requiredstring12Transaction reference number
currency* requiredstring3Currency code Ex: AED
amount* requiredstring20Amount
source_currency* requiredstring3Transaction Currency
source_amount* requiredstring20Transaction amount
auth_codestring32Authorization code
merchant_idstring32Merchant ID number
merchant_category_codestring4SIC
merchant_namestring64Merchant Name
merchant_citystring64Merchant City
merchant_countrystring64Merchant Country
transaction_codestring32Transaction code
merchant_category_groupstring20Category Group
trans_idstring20Transaction Id
balance_typestring20RETAIL
loyalty_codestring32Loyalty Code
loyalty_amountstring32Loyalty amount
loyalty_currencystring32Loyalty currency
labelsstring32Labels
transaction_categorystring32Transaction Category
original_contractstring32Original Contract

{
    "NISrvResponse": {
        "response_get_account_transactions": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GET_ACCOUNT_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": {
                "account_identifier_id": "454545XXXXXX1234",
                "account_identifier_type": "CONTRACT_NUMBER or EXID",
                "transaction_type": "authorized",
                "date_from": "2021-02-02T00:00:00.000Z",
                "date_to": "2021-10-02T00:00:00.000Z",
                "statement_period": "312",
                "no_of_transactions_returned": "019",
                "no_of_transactions_requested": "55",
                "requested_page_no": "55",
                "total_no_of_pages": "55",
                "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_city": "",
                    "merchant_country": "",
                    "transaction_code": "",
                    "merchant_category_group": "",
                    "trans_id": "",
                    "balance_type": ""
                }
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found