API Test Keys

Generate OTP for Payment Source

POST

/v1/upi/tpap/fundsources/:id/otp

Click to copy

Use this endpoint to generate the OTP via the remitter bank while setting the UPI PIN.

Is this page helpful?

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/fundsources/:id/otp' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-device-fingerprint: <device_fingerprint>" \
5-H "x-device-fingerprint-timestamp: 1496918882000" \
6-H "x-customer-reference: customer-id-from-customer" \
7-d '{
8  "vpa":"vpa@handle",
9  "card":{
10    "last6":"123456",
11    "expiry_month":"02",
12    "expiry_year":"26"
13  },
14  "upi_transaction_id":"123456",
15  "device":{
16    "geocode":"1234.1213",
17    "ip":"198.1.1.1"
18    }
19  }'

Response

1{
2  "entity":"upi.fundsource",
3  "id":"fs_1234",
4  "type":"savings",
5  "customer_name":"name",
6  "masked_account_number":"xx9987",
7  "ifsc":"IFSC001",
8  "upi_pin_set":true,
9  "upi_pin_length":4,
10  "otp_length":4,
11  "atm_pin_length":4,
12  "fundsource_provider":{
13    "name":"HDFC Bank",
14    "upi_iin":"600007",
15    "upi_enabled":false,
16    "mobile_registration_format":"format1",
17    "logo_url":"<bank logo url>"
18  },
19  "vpas":{
20    "entity":"collection",
21    "count":1,
22    "items":[
23      {
24        "mobile":"9999999999",
25        "address":"anc@handle",
26        "status":"active",
27        "primary":true
28      }
29    ]
30  },
31  "upi_transaction_id":"123456"
32}

Query Parameters

id

string

The payment source identifier generated as a response from the Create VPA API.

Request Parameters

vpa

string

The VPA linked to the payment source.

card

object

The card details.

Show child parameters (3)

upi_transaction_id

string

The UPI transaction identifier. For example, 123456.

device

object

The device details.

Show child parameters (2)

Response Parameters

entity

string

Name of the entity. Here, it is fundsource.

id

string

Unique identifier of the entity.

type

string

Type of account.

customer_name

string

Name of the account holder.

masked_account_number

string

Masked account number of the customer.

ifsc

string

IFSC of the bank.

upi_iin

string

UPI Issuer Identification Numbers (iin) of the payment source provider issued by NPCI.

upi_pin_set

boolean

Indicates whether the UPI PIN is set. Possible values:

true: UPI PIN is set.
false: UPI PIN is not set.

upi_pin_length

integer

Length of the UPI PIN.

otp_length

integer

Length of the OTP.

atm_pin_length

integer

Length of the ATM PIN.

fundsource_provider

object

Payment source provider details. Here, if the payment source is a bank, payment source providers will be bank information.

Show child parameters (5)

vpas

array

Details of the VPAs linked to the payment source.

Show child parameters (3)

upi_transaction_id

string

Transaction ID of the outgoing request to gateway.

Generate OTP for Payment Source

POST

/v1/upi/tpap/fundsources/:id/otp

Click to copy

Use this endpoint to generate the OTP via the remitter bank while setting the UPI PIN.

Is this page helpful?

Query Parameters

id

string

The payment source identifier generated as a response from the Create VPA API.

Request Parameters

vpa

string

The VPA linked to the payment source.

card

object

The card details.

Show child parameters (3)

upi_transaction_id

string

The UPI transaction identifier. For example, 123456.

device

object

The device details.

Show child parameters (2)

Response Parameters

entity

string

Name of the entity. Here, it is fundsource.

id

string

Unique identifier of the entity.

type

string

Type of account.

customer_name

string

Name of the account holder.

masked_account_number

string

Masked account number of the customer.

ifsc

string

IFSC of the bank.

upi_iin

string

UPI Issuer Identification Numbers (iin) of the payment source provider issued by NPCI.

upi_pin_set

boolean

Indicates whether the UPI PIN is set. Possible values:

true: UPI PIN is set.
false: UPI PIN is not set.

upi_pin_length

integer

Length of the UPI PIN.

otp_length

integer

Length of the OTP.

atm_pin_length

integer

Length of the ATM PIN.

fundsource_provider

object

Payment source provider details. Here, if the payment source is a bank, payment source providers will be bank information.

Show child parameters (5)

vpas

array

Details of the VPAs linked to the payment source.

Show child parameters (3)

upi_transaction_id

string

Transaction ID of the outgoing request to gateway.

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/fundsources/:id/otp' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-device-fingerprint: <device_fingerprint>" \
5-H "x-device-fingerprint-timestamp: 1496918882000" \
6-H "x-customer-reference: customer-id-from-customer" \
7-d '{
8  "vpa":"vpa@handle",
9  "card":{
10    "last6":"123456",
11    "expiry_month":"02",
12    "expiry_year":"26"
13  },
14  "upi_transaction_id":"123456",
15  "device":{
16    "geocode":"1234.1213",
17    "ip":"198.1.1.1"
18    }
19  }'

Response

1{
2  "entity":"upi.fundsource",
3  "id":"fs_1234",
4  "type":"savings",
5  "customer_name":"name",
6  "masked_account_number":"xx9987",
7  "ifsc":"IFSC001",
8  "upi_pin_set":true,
9  "upi_pin_length":4,
10  "otp_length":4,
11  "atm_pin_length":4,
12  "fundsource_provider":{
13    "name":"HDFC Bank",
14    "upi_iin":"600007",
15    "upi_enabled":false,
16    "mobile_registration_format":"format1",
17    "logo_url":"<bank logo url>"
18  },
19  "vpas":{
20    "entity":"collection",
21    "count":1,
22    "items":[
23      {
24        "mobile":"9999999999",
25        "address":"anc@handle",
26        "status":"active",
27        "primary":true
28      }
29    ]
30  },
31  "upi_transaction_id":"123456"
32}