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

Bind Device

This api is used to bind the device to customer. If device binding is not completed before the expiry of sms token, the sms token will be marked as expired.

This api is idempotent for one day.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/customer/bindDevice

                      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.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer
Constraint: Alphanumeric string with dot(.). Maximum length is 256.

                      smsContent
                      *
                      

String

Mandatory

SMS content to be used for device binding for this token
Constraint: As returned by the Get SMS Token api.

                      deviceId
                      *
                      

String

Mandatory

Unique identifier for the device

                      manufacturer
                      *
                      

String

Mandatory

Manufacturer of the device

                      model
                      *
                      

String

Mandatory

Model of the device

                      version
                      *
                      

String

Mandatory

Version of the operating system on the device

                      os
                      *
                      

String

Mandatory

Operating system running on the device

                      ssid
                      *
                      

String

Mandatory

Identifier of the SIM used to send the SMS

                      mobileNumber
                      *
                      

String

Mandatory

Expected mobile number of the customer
Constraint: 12 digits mobile number string

                      packageName
                      *
                      

String

Mandatory

Package name of the UPI application

                      deregisterOldCustomer
                      *
                      

String

Mandatory

Flag denoting whether the older customer can be deregistered or not

                      isOtpRequired
                      
                      

Boolean String

Conditional

Is otp initiation required

otp

String

Conditional

Otp received in sms

                      appHash
                      
                      

String

Conditional

App hash of application to identify Sms

                      senderId
                      
                      

String

Conditional

Sender id of the otp from the sms

                      udfParameters
                      
                      

Stringified Json

Optional

Merchant Defined Parameters.

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API
Values: SUCCESS | FAILURE

                      responseCode	
                      *
                      

String

Mandatory

PSP response code for the API

                      responseMessage	
                      *
                      

String

Mandatory

PSP response message for the API

                      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 as received from the VMN aggregator
Values: 12 digits mobile number string

                      deviceFingerPrint
                      *
                      

String

Mandatory

PSP generated fingerprint for the device used for binding

                      udfParameters
                      
                      

Json String

Optional

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API

                      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

                      customerMobileNumber
                      *
                      

String

Mandatory

Customer mobile number as received from the VMN aggregator

Have questions?
Need help? Contact support
LLM? Read llms.txt