Reset PIN Retry Counter API (V2)

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/pins/retry-counter-resets

This API is used to reset PIN retry counter for requests received through various channels such as online banking or mobile banking.
The Credit+ Issuing system receives, validates, and processes the request. If the request is processed successfully, the system returns the corresponding Service Request number (that is logged in the system) in the API response. In case of failure, the system returns the corresponding error code in the response without logging the Service Request.
The API request is encrypted. Refer to the Message Level Security - AES Encryption section in the Cr+ REST API Security Requirements attachment document for detailed information on encryption of JSON payload.
The API, if sent with Card Number Alias (CNA), will fetch the corresponding associated device for further processing only if DEVICE _STATUS_CODE = NORMAL (0) OR (DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1).

NOTE: This API is an enhancement to version 1 of the Reset PIN Retry Counter API. For using version 1 of this API, refer to the Reset PIN Retry Counter API (V1) section.

HTTP Status and Response Status Matrix

HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
Description: This is the description of the error code returned by Credit+ Issuing application.
Details: This is the detailed description of the error code returned by Credit+ Issuing application

HTTP Code	Reason Code	Description	Details
200	OK	The server has successfully processed your request.
400	UNIQUE_RECORD_NOT_FOUND	Multiple records found for given search criteria.
400	INVALID_FIELD_FORMAT	Incorrect value for field Source.
400	INVALID_FIELD_VALUE	'identifier' field value 'identifier' is invalid.
500	ALIAS_CAPABILITY_NOT_ENABLED	Alias capability not enabled.
400	RECORD_NOT_FOUND	Record not found for given search criteria.
400	DEVICE_STATUS_NOT_SUPPORTED	Device, Operation not permitted
400	ERR_CODE_MISSING_REQUIRED_FIELD	Missing Required Field identifier or packID or alias or number.
400	MISSING_REQUIRED_FIELD	Missing Required Field 'timestamp'.
400	MISSING_REQUIRED_FIELD	Missing Required Field 'DataValidUntilTimestamp'.
400	INVALID_FIELD_LENGTH	Card Pack ID size must be between 10 and 24.
400	INVALID_FIELD_LENGTH	Identifier size must be between 14 and 28.
400	INVALID_FIELD_LENGTH	Program Code size must be between 1 and 10.
400	INVALID_FIELD_LENGTH	Device Plan Code size must be between 1 and 10.
400	INVALID_FIELD_LENGTH	Alias size must be between 1 and 24.
400	INVALID_FIELD_LENGTH	Notes size must be between 1 and 24.
400	TIMESTAMP_ERROR	Request timestamp is in past.	Request timestamp of 'dataValidUntilTimestamp' field value '2021-04-07T02:09:01.200+05:00' is in past
403	AUTHORIZATION_ERROR	User is not authorized to access requested resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

dataValidUntilTimestamp

string

required

length between 20 and 29

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?([+-]\d{2}:\d{2}|Z)$

The date and time after which this encrypted data object is considered invalid. Expressed in ISO-8601 extended format (yyyy-MM-ddTHH:mm:ss[.sss]Z or yyyy-MM-ddTHH:mm:ss[.sss]±hh:mm). Minimum Length: 20, Maximum Length: 29.

device

object

highPriority

boolean

Indicates whether the request needs to be taken on priority. Valid values: true, false.

notes

string

length between 1 and 250

^[A-Za-z0-9, &.\-\']+$

Any free text that the requestor wants to send for logging purpose. Can contain alphabetical pattern (a to z or A to Z), numerics (0 to 9), or characters (,&.-'). Minimum Length: 1, Maximum Length: 250.

timestamp

string

required

length between 20 and 29

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?([+-]\d{2}:\d{2}|Z)$

Date and time of the current transaction as per the timezone of the institution. Expressed in ISO-8601 extended format (YYYY-MM-DDThh:mm:ss[.sss]Z or YYYY-MM-DDThh:mm:ss[.sss]±hh:mm). Minimum Length: 20, Maximum Length: 29.

Headers

X-MC-Correlation-ID

string

^[a-zA-Z0-9-]{1,36}$

API consumer can share unique X-MC-Correlation-ID in HTTP header for each API request. It is recommended to generate UUID (maximum length: 36 alphanumeric characters) that is compliant with RFC 4122. If it is not shared, then the system generates a unique value for each request. For example, ac97d177-9345-4934-8343-0f91a7a02836

X-MC-Channel

string

enum

API consumer can share X-MC-Channel in HTTP header for API requests. It is the network or channel through which request is routed. The only available value for Channel is API.

Allowed:

X-MC-Source

string

API consumer can share X-MC-Source in HTTP header for API requests. It identifies the request originator's application. For the list of source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

X-MC-Client-Application-User-ID

string

length ≤ 50

API consumer can share X-MC-Client-Application-User-ID in HTTP header for API requests. This parameter is a unique identifier to track actual user performing action at the client's end. This field is used only for logging purpose. The maximum length is 50.

Response

200Successful PIN retry counter reset