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

Card Replacement

Status:

Production

Version:

V2

Product:

Debit Solutions

Card Replacement

Overview

This API will allow a cardholder to request a replacement for a card that has been lost, stolen, damaged, or has expired. The API will take the cardholder's identifying information and the reason for the replacement as inputs, and will process the request to order a new card to be issued to the cardholder. This API can also be used to update the card details in the card management system, such as updating the card expiry date or replacing the card with a new one with different features.

How It Works

This API will take card identifier as an input and does Renewal, Replacement, Reissue of existing card. The new card will be linked to the same account and product as the original card. The API will also update the card management system to reflect the change in card status and will ensure that the original card is blocked for future transactions. This API can be used by the cardholder or by an authorized representative of the cardholder to initiate the replacement process.

https://api-sandbox.network.global

Card Replacement

Status:

Production

Version:

V2

Product:

Debit Solutions
/SB/CardServices/Transaction/V2/CardReplacement
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_card_replacementheadermsg_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_CARD_REPLACEMENT”
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”
bodycard_identifier_id* requiredstring32Card Identifier ID
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
card_expiry_datestring4Card's expiry date format is YYMM
card_sequence_numberstring2Sample 01
action_type* requiredstring20Action of the API ex - Renewal, Replacement, Reissue (for Credit and Debit Cards)
new_card_identifier_idstring32Clear Card number. If it was not provided, CMS will generate it
new_card_identifier_typestring20CONTRACT_NUMBER is used for clear card number
instant_issuanceonline_embossingstring1This will tag the physical card for online embossing
embossing_tagskeystring128Key of custom information can be provided as part of this field. These tags are only informational purpose and can be viewed at card plastic info screen
valuestring128Value of custom information can be provided as part of this field. These tags are only informational purpose and can be viewed at card plastic info screen
preembossed_cardidstring32Card Identifier Id
typestring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
custom_fieldskeystring32Custom Tag e.g. preemb
valuestring128Custom Tag value

{
    "NISrvRequest": {
        "request_card_replacement": {
            "header": {
                "msg_id": "1418800217",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CARD_REPLACEMENT",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "9998510116139070070198",
                "card_identifier_type": "EXID",
                "card_expiry_date": "2712",
                "card_sequence_number": "1",
                "action_type": "Replacement",
                "instant_issuance": {
                    "online_embossing": "Y",
                    "embossing_tags": [
                        {
                            "key": "EF.TAG1",
                            "value": "A1B2C3D4E5"
                        }
                    ]
                },
                "custom_fields": [
                    {
                        "key": "preemb",
                        "value": "N"
                    }
                ]
            }
        }
    }
}

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

Node TypeTypeLengthDescription
NISrvResponseresponse_card_replacementheadermsg_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_CARD_REPLACEMENT”
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.
bodynew_card_identifier_id* requiredstring32Card Identifier Id
new_card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
new_card_expiry_date* requiredstring4YYMM
new_masked_pan* requiredstring32Masked card number

{
    "NISrvResponse": {
        "response_card_replacement": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_REPLACEMENT",
                "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": {
                "new_card_identifier_id": "9927230000508669",
                "new_card_identifier_type": "CONTRACT_NUMBER",
                "new_card_expiry_date": "0723",
                "new_masked_pan": "454545XXXXXX1234"
            }
        }
    }
}

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