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

Bulk Card Create

Status:

Production

Version:

V2

Product:

Debit Solutions

Overview

Bulk Card Create is initiated through the submission of a bulk issuance request. This request can be transmitted either via the bulk file interface or the online API, offering flexibility in how users engage with the system. The primary purpose of this application is to facilitate the mass issuance of pre-embossed cards tailored to specific product parameters. By specifying the desired quantity and product details, users can efficiently generate a large volume of cards, streamlining the card issuance process for various purposes.

How It Works

The Financial Institution will request a consolidated batch of 'x' cards in a single submission, with the flexibility to initiate multiple batches as needed. The maximum allowable card request limit for Financial Institutions is set at 9,999. When 'x' number of cards are requested, they are not immediately created. Instead, a request is generated and queued for backend processing. Creation processes are scheduled between 21:20:00 and 04:35:00. For example, a card requested at 13:00:00 will wait until the scheduled processing time for creation. In the context of the Bulk Card Create API, a unique identifier will be provided from our end. Utilizing this identifier, you can retrieve the list of cards, which will include information indicating either this request is in a waiting status, or if it was processed, we will return the actual list of created cards. You have the option to apply multiple filters to the card list, such as filtering by unique identifier, product, or contract status.

  1. BULK_IN_PROGRESS – The cards are in process of being created (cards were created, but embossing file was not extracted).
  2. BULK_READY – The cards are ready to be used.
  3. BULK_USED – This card has already been associated with a specific client, hence it remains in a used state, preventing further linkage.
  4. BULK_CLOSED – This card can no longer be used due to a specific reason, like it is damaged card.

https://api-sandbox.network.global

Bulk Card Create

Status:

Production

Version:

V2

Product:

Debit Solutions
/V2/BulkCardIssuance/CardCreate
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_bulk_card_createheadermsg_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_BULK_CARD_CREATE”
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”
bodyclient_numberstring20Client number/Customer Id or CIF the card will be created under it
product_code* requiredstring50Product code
card_expiry_datestring4Card expiry date format YYMM
number_of_cards* requiredstring4Number of cards needs to be generated
card_design_flagstring2Card design flag
batch_sizestring4batch size is number between 2 and 1000 When this parameter is provided, the generated cards will be split in multiple batches. Suffix '-' will be appended to the batch_idt saved in the cards. Example: 'myfirstbatch-001', 'myfirstbatch-002' etc. If dividing the number_of_cards by batch_size results in more than 999 batches, the request will be declined.
card_name* requiredstring21Embossing name applied to all the cards
company_namestring21Embossing company name applied to all the cards
batch_idtstring60batch id, is an Id managed by FI system and no uniqueness checking on it from our side, if this was not provided, we will generate it.
request_detailssrc_app_codestring32Free text sent by the you, to identify the calling application. Optimized for machine-readable processing like grouping and filtering.
src_app_namestring64Additional tag, repeating the src_app_code, but with a value optimized for direct display.
ext_user_idstring32Free text sent by the bank, to identify the external system’s user.

{
    "NISrvRequest": {
        "request_bulk_card_create": {
            "header": {
                "msg_id": "567890",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_BULK_CARD_CREATE",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "client_number": "112233719988744606",
                "product_code": "982_AED_001_BULK",
                "card_expiry_date": "2803",
                "number_of_cards": "10",
                "card_design_flag": "01",
                "batch_size": "2",
                "card_name": "EMB NAME",
                "company_name": "NI",
                "batch_idt": "BT20240703111111",
                "request_details": [
                    {
                        "src_app_code": "test_app",
                        "src_app_name": "App Name",
                        "ext_user_id": "user1"
                    }
                ]
            }
        }
    }
}

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

Node TypeTypeLengthDescription
headermsg_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 “REP_BULK_CARD_CREATE”
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 - 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”
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.
bodyappl_reg_number* requiredstring60Unique batch code that can be used to query bulk card list to get all cards created as part of this application request

{
    "NISrvResponse": {
        "response_bulk_card_create": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_BULK_CARD_CREATE",
                "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": {
                "appl_reg_number": "BULK_ISS_240314020101"
            }
        }
    }
}

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

Code Description
* *