Reset Login Password API for Cardholder Portal

This API is used to reset the password of the cardholder portal. It is applicable for prepaid product issued on the Pine Labs platform.

NOTE: After the API is successfully processed, a temporary login password is sent to the cardholder’s registered email address.

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.
  • Reason: This is the description of the error code returned by Credit+ Issuing application.
HTTP CodeError CodeReason
201000Success.
401144Invalid Card Pack Id.
401902Invalid Device.
400997Bad Request.
401900User Or Bank does not support API.
500999Error while processing request.
500912Forward offset time limit violated.
500913Backward offset time limit violated.
500951System Internal Error.
408902Invalid Transaction.
403909System Malfunction.
404914Original Transaction not Found.
500EAD001Either invalid device or device status code not normal.
500EAD002Invalid device.
500EAD003Device number not found.
500EAD004Invalid Card pack id.
500EAD005Invalid form factor type.
500EAD006Device is not in normal state.
500GETDEV004Error while fetching device number.
400ECOM002Date entered for fromdate and todate should not be less than institution business date.
500CNA001Bank Does Not Exists.
500CNA003Record does not exists for the given device details.
500CNA004Multiple device numbers are linked for given details.
500CNA006Error while fetching device details.
500CNA002Card Number Alias Functionality is not applicable for this Institution.
401GETTAM001Invalid User Id.
401GETTAM009Invalid User Id.
401CHPRPAH001Error while reset the password in AuthAPI.
500HDE006Invalid device.
500HDE409Device is not normal.
500HDE305Invalid Program code.
500HDE259DEVICE is already de-activated.
500HDE260DEVICE is already activated for life long use.
500HDE261DEVICE is already activated for N hours.
500HDE265DEVICE is already activated for a specific period.
500HDE264Only Activated DEVICE can be De-Activate.
500EAD001Either invalid device or device status code not normal.
500EAD002Invalid device.
500EAD003Device number not found.
400994Invalid Encryption-Algorithm header value.
400994Invalid Encryption Request Parameters.
400994Cryptography error.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
length between 3 and 3

Form Factor Type is to identify if it is Card Number (CRD), Card Number Alias (CNA), Card Pack ID (CPI), or User ID (UID). Alphanumeric. Length: 3. Not Null. Fix length 3. Either CRD or CNA or CPI or UID. Example: CRD

Allowed:
string
required
length between 10 and 24
^[A-Za-z0-9!'()$^*+,-.]+$

If formFactorType is CRD then Card Number should be sent in the request. If formFactorType is CNA then Card number alias should be sent in the request. If formFactorType is CPI then Card Pack ID should be sent in the request. If the formfactor type is UID then the Cardholder portal user ID should be sent in the request. Alphanumeric. Length: 10 to 24. Not Null. Min Length 10. Maxlength 24. If Card Number Alias flag at institution level is off and form factor received is CNA then the request is declined. Example: 5959210000880117

string
enum
length between 2 and 2

Accessing channel. Valid values: API. Not NULL. Fixed length: 2. Valid channels as provided to the institution at the time of onboarding. Example: API

Allowed:
string
enum
length ≤ 1

Product type of Device. String. Allowed values (P). This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: P

Allowed:
string
length ≤ 6
^[A-Za-z0-9][A-Za-z0-9_]*[A-Za-z0-9]$|^$

Program attached to the device. Alphanumeric. Maximum Length: 6. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: WPS02

string
length ≤ 10
^[A-Za-z0-9][A-Za-z0-9_]*[A-Za-z0-9]$|^$

Device Plan Code attached with the device. Alphanumeric. Maximum Length: 10. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Example: WPS

string
required
^[0-9]+$

Current UTC timestamp in milliseconds. Numeric. AES key expiration criteria depends on input UTC timestamp. Applicable only for encrypted requests. Example: 1563877848815

Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

string
enum
required

API Consumer must share Encryption-Algorithm as a key (value: DES168) in HTTP header in order to encrypt the API requests.

Allowed:
string

API Consumer can share Source in HTTP header for API requests. 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.

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json