JavaScript is disabled. Some features may not work. You can also read the static version: View text version

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

                      Content-Type
                      *
                      

string

Required

The type of content of request

                      x-merchant-id
                      *
                      

string

Required

provided at time of onboarding

                      x-merchant-channel-id
                      *
                      

string

Required

provided at time of onboarding

                      Accept
                      *
                      

string

Required

The type of content of response

                      x-timestamp
                      *
                      

integer

Required

timestamp of the request

                      x-merchant-checksum
                      *
                      

string

Required

checksum calculated for the request body

Body

                      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

bankAccountUniqueId in the response of Fetch Accounts api call.

                      customerVpa
                      *
                      

String

Mandatory

VPA of the customer linked to the account

Constraints:something@handle

                      otpRequestType
                      *
                      

String

Mandatory

Type of OTP request BANK, UIDAI, BANK-UIDAI

                      aadhaarNo
                      
                      

String

optional

First 6 digits for customer aadhaar number

Constraints:To be populated if otpRequestType = UIDAI

                      udfParameters
                      
                      

json String

optional

Stringified JSON for udf parameters

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API

Values:SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API

Refer error code section

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API

Refer error code section

                      payload
                      
                      

json

                      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

12 digits mobile number string

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the selected bank account

As passed in the request

                      bankCode
                      *
                      

String

Mandatory

Bank code of the account which was used

Valid bank IIN

                      customerVpa
                      *
                      

String

Mandatory

Vpa of the customer linked to this account

As passed in the request

                      maskedAccountNumber
                      *
                      

String

Mandatory

Masked account number of the account which was used

XXXX123456

                      mobRegFormat
                      *
                      

String

Mandatory

Mobile registraion format type

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

SUCCESS, FAILURE

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway

                      udfParameters
                      
                      

json String

optional

Udf parameters as passed in the request