API Test Keys
Resolve VPAs
POST
/v1/upi/tpap/vpa/resolve
Click to copy
TPAP resolves a VPA address to find the name of the entity to which the VPA belongs and its source before collecting a payment. Below are the expected responses:
- Payment source information such as
name
,ifsc
andupi_iin
are sent in response only when NPCI responds to switch as the VPA is verified. isMerchantVerified
,mcc
andmerchantType
are sent in response only when the VPA of a merchant is verified.
Use this endpoint to Resolve a VPA.
Is this page helpful?
Curl
Response
1{2"entity":"upi.vpa",3"upi_transaction_id":"TXNxmms",4"address":"kunal-1@rzpa",5"fundsource":{6"customer_name":"kunal1",7"ifsc":"SBI00001",8"upi_iin":""9},10"is_merchant_vpa":true,11"is_merchant_verified":true,12"mcc":"string",13"merchant":{14"identifier":{15"subcode":"string",16"mid":"string",17"sid":"string",18"tid":"string",19"merchant_type":"string",20"merchant_genre":"string",21"onboarding_type":"string"22},23"name":{24"brand":"string",25"legal":"string",26"franchise":"string"27},28"ownership":{29"type":"string"30}31},32"feature_tags":[33"string"34]35}
Request Parameters
vpa
*
string
VPA that is to be resolved.
device
string
Device details.
Show child parameters (2)
Response Parameters
entity
string
Name of the entity.
upi_transaction_id
string
The transaction identifier of UPI.
address
string
The VPA address being resolved.
fundsource
object
The payment source details.
Show child parameters (3)
is_merchant_vpa
boolean
Indicates whether the VPA belongs to merchant. Possible values:
true
: Merchant VPA.false
: Not merchant VPA.
is_merchant_verified
boolean
Indicates whether merchant is verified. Possible values:
true
: Merchant is verified.false
: Merchant is not verified.
mcc
string
The merchant category code for the merchant.
merchant
object
Business details.
Show child parameters (3)
feature_tags
string
Indicates an array of feature values. Each has its significance as decided by NPCI. Possible values:
mandate
credit
ppi
uod
voucher
Resolve VPAs
POST
/v1/upi/tpap/vpa/resolve
Click to copy
TPAP resolves a VPA address to find the name of the entity to which the VPA belongs and its source before collecting a payment. Below are the expected responses:
- Payment source information such as
name
,ifsc
andupi_iin
are sent in response only when NPCI responds to switch as the VPA is verified. isMerchantVerified
,mcc
andmerchantType
are sent in response only when the VPA of a merchant is verified.
Use this endpoint to Resolve a VPA.
Is this page helpful?
Request Parameters
vpa
*
string
VPA that is to be resolved.
device
string
Device details.
Show child parameters (2)
Response Parameters
entity
string
Name of the entity.
upi_transaction_id
string
The transaction identifier of UPI.
address
string
The VPA address being resolved.
fundsource
object
The payment source details.
Show child parameters (3)
is_merchant_vpa
boolean
Indicates whether the VPA belongs to merchant. Possible values:
true
: Merchant VPA.false
: Not merchant VPA.
is_merchant_verified
boolean
Indicates whether merchant is verified. Possible values:
true
: Merchant is verified.false
: Merchant is not verified.
mcc
string
The merchant category code for the merchant.
merchant
object
Business details.
Show child parameters (3)
feature_tags
string
Indicates an array of feature values. Each has its significance as decided by NPCI. Possible values:
mandate
credit
ppi
uod
voucher
Curl
1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/vpa/resolve' \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": "pay2me@okhdfbank",9"device": {10"geocode": "1234.1213",11"ip": "198.1.1.1"12}13}'
Response
1{2"entity":"upi.vpa",3"upi_transaction_id":"TXNxmms",4"address":"kunal-1@rzpa",5"fundsource":{6"customer_name":"kunal1",7"ifsc":"SBI00001",8"upi_iin":""9},10"is_merchant_vpa":true,11"is_merchant_verified":true,12"mcc":"string",13"merchant":{14"identifier":{15"subcode":"string",16"mid":"string",17"sid":"string",18"tid":"string",19"merchant_type":"string",20"merchant_genre":"string",21"onboarding_type":"string"22},23"name":{24"brand":"string",25"legal":"string",26"franchise":"string"27},28"ownership":{29"type":"string"30}31},32"feature_tags":[33"string"34]35}