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

Pin Tries Counter Reset

Status:

Production

Version:

V2

Product:

Debit Solutions

PIN Retry Counter Reset

Overview

The "Reset PIN Try Counter" API allows consumers to manually reset the counter that tracks the number of consecutive times a cardholder has entered an incorrect PIN. This API is useful in situations where a cardholder has exceeded the predefined limit of incorrect PIN attempts and is unable to make transactions as a result.

When a cardholder enters an incorrect PIN, the card's PIN Try Counter is incremented by one. Cards have a predefined limit for the number of incorrect PIN attempts before being blocked for transactions. If a cardholder exceeds this threshold and is unable to transact, this API can be utilized to reset the counter and restore the ability for the cardholder to make transactions.

How It Works

This API allows businesses to easily reset the PIN try counter for a specific card. By utilizing this API, businesses can ensure that authorized cardholders are able to access their account and perform transactions even if they have entered it incorrectly a certain number of times.

To use the API, businesses will need to make an HTTPS POST request to the API endpoint, including the necessary parameters such as the card number in the request body. The API will then process the request and connect to the card issuer's systems or network to retrieve the PIN Try Counter associated with the provided card number and reset it to zero. The API will then generate a response indicating whether the counter has been reset successfully or not, which the API consumers can then use to take the necessary actions.

It is important to note that this API can only be used if the card issuer or the financial institution is using this service provided by the API and the card is active and not blocked. Additionally, it is highly recommended to offer this feature only after securely validating the identity of the cardholder (in-app biometrics, security questions, etc.) and ensuring the card was not lost/stolen for security reasons.

https://api-sandbox.network.global

Pin Tries Counter Reset

Status:

Production

Version:

V2

Product:

Debit Solutions
/SB/CardServices/Transaction/V2/PinTriesCounterReset
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_pin_counter_resetheadermsg_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_PIN_RETRIES_COUNTER_RESET”
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

{
    "NISrvRequest": {
        "request_pin_counter_reset": {
            "header": {
                "msg_id": "1206231104",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_PIN_RETRIES_COUNTER_RESET",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2023-06-12T12:01:08.8+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984100128180710456",
                "card_identifier_type": "EXID"
            }
        }
    }
}

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

Node TypeTypeLengthDescription
NISrvResponseresponse_pin_counter_resetheadermsg_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_PIN_RETRIES_COUNTER_RESET”
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 Date & time Format DD/MM/YYYY HH:MM:SS
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.

{
    "NISrvResponse": {
        "response_pin_counter_reset": {
            "header": {
                "msg_id": "1206231104",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_PIN_RETRIES_COUNTER_RESET",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2023-06-12T12:01:08.8+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-06-12T12:01:08.8+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