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 List Of Cards

Status:

Production

Version:

V2

Product:

Debit Solutions

Overview

Bulk list of cards can be used for stock management, which lists all generated pre-embossed cards, with the option to request the list by:

  1. client_number: client number used in the bulk card create request
  2. product_code: specific product code
  3. countr_status_code: card status (statuses described in bulk card create)
  4. appl_reg_number: Unique request identifier that we will return as part of the card create response.
  5. batch_idt: batch idt used in the bulk card create request
  6. card_identifier_id: option to filter by specific card or EXID

How It Works

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.

There are four statuses for cards:

  1. appl_resp_code: application response code which will indicate if the request was accepted or not.
  2. appl_resp_text: application response text which will give a test description about the request.
  3. appl_posting_status: application posting status which will indicate if the request in waiting status, the expected value if the request is in waiting stats is “Waiting”

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.

https://api-sandbox.network.global

Bulk List Of Cards

Status:

Production

Version:

V2

Product:

Debit Solutions
/V2/BulkCardIssuance/ListOfCards
<tbody><table class="api-tables"> <thead> <tr><th>Node</th> <th colspan="3">Child Node</th> <th>Type</th> <th>Length</th> <th>Description</th> </tr> </thead><tr><td ><req >* </req></td><td colspan="3"><req >* </req></td><td></td><td></td><td></td></tr></tbody> </table>
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_listheadermsg_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 “REQ_LIST_OF_BULK_CARD”
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 linked to the card
product_codestring50Product Code
product_code_tgtstring50Code of the client card-level product for which this bulk card is suitable
contr_status_codestring32Status of the card in the bulk batch
appl_reg_numberstring60Unique batch id genereted by NI system
batch_idtstring60batch Idt
card_identifier_idstring32Card Identifier Id
card_identifier_typestring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS

{
    "NISrvRequest": {
        "request_bulk_card_list": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_LIST_OF_BULK_CARD",
                "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",
                "product_code_tgt": "982_AED_001",
                "contr_status_code": "BULK_IN_PROGRESS",
                "appl_reg_number": "BULK_ISS_240314020101",
                "batch_idt": "BT20240703111111",
                "card_identifier_id": "99985101161390700708",
                "card_identifier_type": "EXID"
            }
        }
    }
}

Node Child Node Type Length Description
* *

Node TypeTypeLengthDescription
NISrvResponseresponse_bulk_card_listheadermsg_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_LIST_OF_BULK_CARD”
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.
bodyclientsclient_numberstring20Client number/Customer Id or CIF linked to the card
client_short_namestring255Client short name
batchesbatch_idtstring60batch Idt
cardscard_identifier_idstring32Card Identifier Id
card_identifier_typestring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
panstring16card number
product_codestring50Product code
product_namestring100Product name
date_openstring10Date of card creation
date_closedstring10Date of closing the card
contr_status_codestring32Status of the card in the bulk batch
production_statusstring1Card production status, M: Marked for embossing, L: Locked
card_expiry_datestring4Card's expiry date the Format is YYMM
card_namestring21Card embossing name defined on client level should be in Upper case
company_namestring21Embossing company name applied to all the cards
appl_resp_codestring3Application response code
appl_resp_textstring255Application response text
appl_posting_statusstring20Application posting status

{
    "NISrvResponse": {
        "response_bulk_card_list": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_LIST_OF_BULK_CARD",
                "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": {
                "clients": [
                    {
                        "client_number": "112233719988744606",
                        "client_short_name": "NI",
                        "batches": [
                            {
                                "batch_idt": "BT20240703111111",
                                "cards": [
                                    {
                                        "card_identifier_id": "99985101161390700708",
                                        "card_identifier_type": "EXID",
                                        "pan": "9998510116139070",
                                        "product_code": "982_AED_001_BULK",
                                        "product_name": "982-PS AED Visa Classic - Bulk",
                                        "date_open": "2022-01-01",
                                        "date_closed": "2022-01-01",
                                        "contr_status_code": "BULK_IN_PROGRESS",
                                        "production_status": "M",
                                        "card_expiry_date": "0528",
                                        "card_name": "JAMES ROBERT",
                                        "company_name": "NI"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Node Child Node Type Length Description

Node Child Node Type Length Description
* *