Generate OTP

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/cardholder/otp

This API is used to generate one-time password (OTP) for requests received through various channels. The Credit+ Issuing system receives, validates and processes the request. If the request is successful, the system generates a new OTP and saves it in the database. The cardholder will receive the OTP through SMS and/or e-mail alert. If the request fails, the system returns the corresponding error code.

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 Code	Error Code	Reason
400	997	Device Number and Card Number Alias fields are empty. Please provide value for atleast one field.
400	997	Product Type field is invalid.
400	997	Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Program Code field value must have max length 6.
400	997	Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Device Plan Code field value must have max length 10.
400	997	Only alphanumeric characters and special characters [_!'()*+,-.] are allowed.
400	997	Card Number Alias field value must have max length 24.
400	997	Card number is of invalid format.
400	997	Request type field is empty.
400	997	Channel field is empty.
401	990	Channel not authenticated for this service
401	991	OTP request notsupported forthisservice
400	997	Device does not exist
404	998	Device number not registered in the system
500	989	No Notification method available for user
500	993	‘This message will be received from encryption methodologies’
500	989	Notification alert failed.
201	000	SUCCESS
500	CNA001	Bank Does Not Exists
500	CNA002	Card Number Alias Functionality is not applicable forthisInstitution
500	CNA003	Record does not exists for the given details
500	CNA005	Multiple device numbers are linked for given details
500	CNA006	Error while fetching device details

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

deviceNumber

string

required

length ≤ 24

^[0-9]+$

Card number. Must be numeric and up to 24 characters. Mandatory if cardNumberAlias is not present.

cardNumberAlias

string

length ≤ 24

^[a-zA-Z0-9!'()*+,-._]+$

Alias assigned to each device. Mandatory if deviceNumber is not present. Must be alphanumeric with allowed special characters (! ' ( ) * + , - . _). Up to 24 characters.

productType

string

enum

Product type of the device. Valid values are 'P' (Pre-paid), 'C' (Credit), 'D' (Debit). Required when cardNumberAlias is present and multiple devices are linked to the same cardNumberAlias.

Allowed:

devicePlanCode

string

length ≤ 10

^[a-zA-Z0-9]+$

Device Plan Code attached to the device. Must be alphanumeric and up to 10 characters. Required when cardNumberAlias is present and multiple devices are linked to the same cardNumberAlias.

programCode

string

length ≤ 6

^[a-zA-Z0-9]+$

Program attached to the device. Must be alphanumeric and up to 6 characters. Required when cardNumberAlias is present and multiple devices are linked to the same cardNumberAlias.

requestType

string

required

Request type for which OTP verification is invoked. Valid values are configured in Institution Parameter Setup > System Codes against TYPE_ID = GENERATE_OTP.

channel

string

required

Accessing channel for the request. Must be a valid channel as provided to the institution during onboarding.

Headers

Source

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201OTP generated successfully