Send OTP API

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

The Send OTP API is used to:

  • Used to send the OTP to verify the merchant’s primary details or bank update details
  • Used to generate the user token required for authorization

This is authorised through a client token generated using the client ID and secret.

📘

Note:

The access token is required in the Bearer field of the header. For more information on getting the access token, refer to Get Token API.

Environment

Sample request
curl --location -g --request POST '{{partner_base_url}}/api/v1/otps/send_otp' \ --header 'Authorization: Bearer {{access_token}}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'otp[identity]=9044199921' \ --data-urlencode 'otp[scope]=user_profile' \ --data-urlencode 'otp[channels]=sms' \ --data-urlencode 'otp[type]=SignIn'
Sample request
{
  "data": {
    "id": "11ea-bf84-27aef522-85a0-02f413145cce",
    "type": "notifications",
    "attributes": {
      "status": "sidekiq_queued",
      "send-at": "1594038491",
      "status-details": {},
      "payload": {
        "sms": [
          "90xxxxxx21"
        ]
      }
    }
  }
}

Request Parameters

Additional info for request parameters
ParameterDescription
otp[scope]Indicates the purpose of the API. The following APIs use different scopes in this field
Add or Update Bank Detail API uses any of the following according to the use case:
- create_bank_details
- update_bank_details
For Payment Link APIs:
- Create Payment Link API: create_payment_links
- Get Single Payment Link API: read_payment_links
- Change Status and Expiry for a Payment Link API: update_payment_links
Form Data
string
required

Indicates the entity on which the OTP is to be sent. For example, Phone Number

string
required

Indicates the purpose of the API. For more details, refer to Additional Info table.

string
required

Indicates the way or medium through which the OTP should be sent the merchant

string
required

ndicates the type of OTP you want to receive depending upon the action to be performed.

Headers
const
required
Response
200
Language
Credentials
Click Try It! to start a request and see the response here!