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 Status Change

Status:

Production

Version:

V2

Product:

Debit Solutions

Card Status Change

Overview

This API allows for the change of status of a card or account. It is primarily used for blocking or unblocking a card, in cases where a cardholder has reported their card as lost or stolen, for example. This API can also be used for other status changes such as activating or deactivating a card. The API requires proper authentication and authorization to ensure that only authorized parties are able to make these changes.

How It Works

This API allows you to change the status of a card or account to a new value. It is primarily used for blocking or unblocking a card. When you want to change the status of a card or account, you can use this API to do so. The API requires you to provide the card or account information, as well as the new status that you want to set. The API will then process your request and update the status of the card or account accordingly. Once the status has been changed, it will be reflected in the system and will be used for all further transactions. If this API not used properly, it could result in account or card being blocked or unblocked which could have significant impact on cardholder's banking experience. Overall, this API allows for quick and efficient management of card or account statuses, making it easy to maintain the security and integrity of your financial systems.

https://api-sandbox.network.global

Card Status Change

Status:

Production

Version:

V2

Product:

Debit Solutions
/SB/CardServices/Transaction/V2/CardStatusChange
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_STATUS_CHANGE”
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
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 EXPIRY DATE
statustype* requiredstring32Status Type
value* requiredstring32Status value
custom_fieldskeystring20Custom Tag
valuestring128Tag value

{
    "NISrvRequest": {
        "request_card_status_change": {
            "header": {
                "msg_id": "56532898",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CARD_STATUS_CHANGE",
                "src_application": "CRM",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984100111514120378",
                "card_identifier_type": "EXID",
                "status": {
                    "type": "BCC-CARD-982",
                    "value": "T"
                },
                "custom_fields": [
                    {
                        "key": "bc_channel",
                        "value": "TIB2"
                    }
                ]
            }
        }
    }
}

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

Node TypeTypeLengthDescription
headermsg_id* requiredstring12Unique Source Message ID eg ada123456fdsf
msg_type* requiredstring12msg_type can hold 2 values TRANSACTION or ENQUIRY, the value must be sent as it is mentioned in the request
msg_function* requiredstring50Default REP_CARD_STATUS_CHANGE
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”
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.

{
    "NISrvResponse": {
        "response_card_status_change": {
            "header": {
                "msg_id": "56532898",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_STATUS_CHANGE",
                "src_application": "CRM",
                "target_application": "WAY4",
                "timestamp": "2024-03-19T14:04:23.065+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2024-03-19T14:04:23.065+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            }
        }
    }
}

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