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 Update

Status:

Production

Version:

V2

Product:

Debit Solutions

Card Update

Overview

The API provides the capability to update an existing card associated with a specific account and cardholder. This includes updating card information such as the expiration date, card status, etc. The API requires specific information to be provided such as the card identifier in order to update the card. This feature allows businesses to keep their customer's card information updated, ensuring smooth transaction processing and reducing the risk of fraudulent activities. The functionality provided by this API can be useful for updating cards.

How It Works

The Card Update API facilitates the modification of existing card information for a specific account and cardholder. The API requires certain input parameters, such as the card number, account number, and cardholder details, to be provided in order to update the specified card.

Upon receiving the input parameters, the API connects to the card management system and updates the card information with the provided details, such as the expiration date or card status. The updated card remains linked to the same account and cardholder as before and can continue to be utilized for transactions.

Additionally, this API also provides the capability to update multiple cards under a single account. This feature allows businesses to update multiple cards efficiently, reducing the time and effort required for updating individual cards.

https://api-sandbox.network.global

Card Update

Status:

Production

Version:

V2

Product:

Debit Solutions
/SB/CardServices/Transaction/V2/CardUpdate
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
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 “REQ_CARD_UPDATE”
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* requiredstring20Card Identifier Id
card_identifier_type* requiredstring32CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
cardbranch_code* requiredstring10Branch Code, if no branches are used, the code must be same as bank_code
card_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
custom_fieldskeystring20Custom Tag. Ex: CN-CONTRACT_NAME
valuestring128Tag value. Ex: John doe

{
    "NISrvRequest": {
        "request_card_update": {
            "header": {
                "msg_id": "236501",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CARD_UPDATE",
                "src_application": "IVR",
                "target_application": "PCMS",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984100111514120378",
                "card_identifier_type": "EXID",
                "card": {
                    "branch_code": "982",
                    "card_identifier_id": "99984100111514120378",
                    "card_identifier_type": "EXID",
                    "custom_fields": [
                        {
                            "key": "CN-CONTRACT_NAME",
                            "value": "John doe"
                        }
                    ]
                }
            }
        }
    }
}

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_CARD_UPDATE”
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* requiredstring20 Application Name
date_time* requiredstring30 Timestamp of the response Format YYYY-MM-DD HH:MM:SS
status* requiredstring1 Status of the request (S/F)
error_code* requiredstring4 EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100 Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20 The tracking_id sent in the request will be sent back in response in this field.
bodycard_identifier_id* requiredstring32card identifier
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
custom_fieldskeystring20Custom Tag. Ex: CN-CONTRACT_NAME
valuestring128Tag value. Ex: John doe

{
    "NISrvResponse": {
        "response_card_update": {
            "header": {
                "msg_id": "236501",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_UPDATE",
                "src_application": "IVR",
                "target_application": "PCMS",
                "timestamp": "2024-02-15T15:03:22.511+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-02-15T15:03:22.511+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "card_identifier_id": "99984100111514120378",
                "card_identifier_type": "EXID",
                "custom_fields": [
                    {
                        "key": "CN-BC_C1",
                        "value": "_"
                    },
                    {
                        "key": "CN-CARD_DESIGN_FLAG",
                        "value": "00"
                    },
                    {
                        "key": "CN-CONTRACT_NAME",
                        "value": "John doe"
                    },
                    {
                        "key": "CN-DATE_OPEN",
                        "value": "2022-01-01"
                    },
                    {
                        "key": "CN-EXID",
                        "value": "99984100111514120378"
                    },
                    {
                        "key": "CN-NCONTROL_ENROLMENT",
                        "value": "N"
                    }
                ]
            }
        }
    }
}

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