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

Get SMS Token

This API will start the device binding process and return an sms token. The sms token will provide the sms text and the virtual mobile number(VMN) for the sms to be sent from customer device. A new sms token will be returned every time this api is called.

Request

Response

API Endpoints

Production Link

POST

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

                      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
Constraints : Alphanumeric string with dot(.). Maximum length is 256.

                      deviceId
                      *
                      

String

Mandatory

Unique identifier for the device

                      provider
                      
                      

String

optional

Cellular provider for VMN selection strategy

os

String

optional

Operating system running on the device

                      udfParameters
                      
                      

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

                      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

                      serviceProviders
                      *
                      

Array of object

Mandatory

Array of VMNs that can be used for device binding for this token

                      name
                      *
                      

String

Mandatory

Name of the VMN service provider like Vodafone, Airtel

                      number
                      *
                      

Numeric String

Mandatory

Number of the VMN service provider

                      smsContent
                      *
                      

String

Mandatory

SMS content to be used for device binding for this token

                      expiryTimestamp
                      *
                      

String

Mandatory

Expiry timestamp for the SMS token
YYYY-MM-DDTHH:MM:SS+05:30

                      udfParameters
                      
                      

json String

Optional

Udf parameters as passed in the request

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