API Test Keys
Check VPA Availability
POST/v1/upi/tpap/vpa/availableClick to copy
Use this endpoint to check if the VPA is available. If available, you can link it to the payment source. Otherwise, try searching for another available VPA before linking it.
The default VPA logic is (mobile number)@handle. For example, 9000090000@airtelbank. Multiple TPAPs can use the same logic. Hence, the requested VPA may be not available. Therefore, we need to expose a functionality to check whether a VPA is available.
Is this page helpful?
Curl
1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/vpa/available' \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": "customer@handle"9}'
Response
1{2"available":true,3"mobile":"919999999999",4"vpa_suggestions":[5"sample@vpa"6]7}
Request Parameters
vpa *
stringThe VPA. You must generate this VPA for customers and check if it is available before trying to link it to the payment source (bank account).
Response Parameters
availablebooleanIndicates whether the VPA is available. Possible values:
true: VPA is available.false: VPA is not available.
mobilestringMobile number of the customer.
vpa_suggestionsarrayList of VPA suggestions.
Check VPA Availability
POST/v1/upi/tpap/vpa/availableClick to copy
Use this endpoint to check if the VPA is available. If available, you can link it to the payment source. Otherwise, try searching for another available VPA before linking it.
The default VPA logic is (mobile number)@handle. For example, 9000090000@airtelbank. Multiple TPAPs can use the same logic. Hence, the requested VPA may be not available. Therefore, we need to expose a functionality to check whether a VPA is available.
Is this page helpful?
Request Parameters
vpa *
stringThe VPA. You must generate this VPA for customers and check if it is available before trying to link it to the payment source (bank account).
Response Parameters
availablebooleanIndicates whether the VPA is available. Possible values:
true: VPA is available.false: VPA is not available.
mobilestringMobile number of the customer.
vpa_suggestionsarrayList of VPA suggestions.
Curl
1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/vpa/available' \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": "customer@handle"9}'
Response
1{2"available":true,3"mobile":"919999999999",4"vpa_suggestions":[5"sample@vpa"6]7}