API Test Keys

Get a Mobile Number Verification Token

POST

/v1/upi/tpap/mobile/verification

Click to copy

Use this endpoint to get a mobile number verification token.

Is this page helpful?

Request

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/mobile/verification' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-customer-reference: 919999999999" \
5-d '{
6  "device":{
7    "uuid":"<device_id>",
8    "app":"app.merchant.upi.com",
9    "ssid":"123456789",
10    "manufacturer":"samsung",
11    "model":"Galaxy S23",
12    "os":"android",
13    "os_version":"Dev12345",
14    "ip":"ip of the device",
15    "geocode":"geographical code of the device"
16    },
17  "verification_type":"sms",
18  "mobile":"91999999999",
19  "network_provider":"vodafone"
20}'

Response

1{
2  "verification_type":"sms",
3  "sms":{
4    "content":"UPIACT ad56ef90396348bac56099",
5    "receiver_number":[
6      {
7        "network_provider":"vodafone",
8        "mobile":"09988776655"
9      },
10      {
11        "network_provider":"airtel",
12        "mobile":"09876543210"
13      }
14    ]
15  },
16  "expire_at":1715836058
17}

Request Parameters

customer_reference

string

The unique identifier the merchant has created for the customer. This should be passed as a header. Know more about

headers

device

object

The device details.

Show child parameters (9)

verification_type

string

The verification type. Possible value is sms.

mobile

string

The mobile number.

network_provider

string

Network provider on the selected mobile number.

Response Parameters

verification_type

string

The verification type.

sms

object

Details required for verification via SMS.

Show child parameters (2)

expire_at

string

The expiry time of the verification request in UNIX timestamp.

Get a Mobile Number Verification Token

POST

/v1/upi/tpap/mobile/verification

Click to copy

Use this endpoint to get a mobile number verification token.

Is this page helpful?

Request Parameters

customer_reference

string

The unique identifier the merchant has created for the customer. This should be passed as a header. Know more about

headers

device

object

The device details.

Show child parameters (9)

verification_type

string

The verification type. Possible value is sms.

mobile

string

The mobile number.

network_provider

string

Network provider on the selected mobile number.

Response Parameters

verification_type

string

The verification type.

sms

object

Details required for verification via SMS.

Show child parameters (2)

expire_at

string

The expiry time of the verification request in UNIX timestamp.

Request

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/mobile/verification' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-customer-reference: 919999999999" \
5-d '{
6  "device":{
7    "uuid":"<device_id>",
8    "app":"app.merchant.upi.com",
9    "ssid":"123456789",
10    "manufacturer":"samsung",
11    "model":"Galaxy S23",
12    "os":"android",
13    "os_version":"Dev12345",
14    "ip":"ip of the device",
15    "geocode":"geographical code of the device"
16    },
17  "verification_type":"sms",
18  "mobile":"91999999999",
19  "network_provider":"vodafone"
20}'

Response

1{
2  "verification_type":"sms",
3  "sms":{
4    "content":"UPIACT ad56ef90396348bac56099",
5    "receiver_number":[
6      {
7        "network_provider":"vodafone",
8        "mobile":"09988776655"
9      },
10      {
11        "network_provider":"airtel",
12        "mobile":"09876543210"
13      }
14    ]
15  },
16  "expire_at":1715836058
17}