Body
Set/Reset Mpin
This api can be used to set/reset mpin for a customer bank account. Set/reset mpin is successful only when gatewayResponseCode = "00"
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/accounts/setMpin
Headers
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
Parameter
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
credBlock
*
String
Mandatory
Encrypted credblock for containing user otp and mpin
Constraints:As returned by Common Library
udfParameters
*
json String
Mandatory
Stringified JSON for udf parameters
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
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
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
udfParameters
JSON
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt