Body
Generate otp
This api can be used to generate an otp to be used for set/reset mpin process. Customer has to entre this otp in the Common Library page.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/accounts/otp
Headers
Content-Type
*
string
Required
application/json
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraints : 35 character alphanumeric. Should always start with merchant prefix provided.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Constraints : bankAccountUniqueId in the response of Fetch Accounts api call.
customerVpa
*
String
Mandatory
VPA of the customer linked to the account
Constraints : something@handle
card
String
optional
Last 6 digits of the debit card
expiry
String
Optional
Expiry of the debit card
Constraints : String in format MMYY (pass 0149 for Maestro cards)
udfParameters
Json String
optional
Stringified JSON for udf parameters
otpRequestType
String
optional
Type of OTP request - BANK, UIDAI, BANK-UIDAI. This parameter is required to use Aadhaar OTP onboarding
aadhaarNo
String
optional
First 6 digits for customer aadhaar number. This parameter is required to use Aadhaar OTP onboarding
clVersion
String
Optional
Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values : SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values : Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values : Refer error code section
Payload
*
JSON
Mandatory
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
customerMobileNumber
*
String
Mandatory
Customer mobile number
Values : 12 digits mobile number string
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Values : As passed in the request
bankCode
*
String
Mandatory
Bank code of the account which was used
Values : Valid bank IIN
customerVpa
*
String
Mandatory
Vpa of the customer linked to this account
Values : As passed in the request
maskedAccountNumber
*
String
Mandatory
Masked account number of the account which was used
Values : XXXX123456
mobRegFormat
*
String
Mandatory
Mobile registraion format type
Values : FORMAT1, FORMAT2
mpinLength
*
String
Mandatory
MPIN length for the account
otpLength
*
String
Mandatory
OTP length for the account
atmPinLength
*
String
Mandatory
ATM PIN length for the account used for FORMAT2 usecases
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values : SUCCESS, FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
uidaiErrorCode
String
Optional
Error code related to UIDAI
udfParameters
Json String
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt