Request
Curl
Response
Response
Parameters
upi_number mandatory
: string The UPI number to check for availability (mobile or numeric id).
device mandatory
: object The device details.
geocode
: string The location coordinates of the device.
ip
: string The IP address of the device.
Parameters
entity
: string Collection of entity. Here it is upi_number.
number
: string The UPI number.
upi_transaction_id
: string Unique transaction id created by the originator.
vpa
: string VPA linked to the UPI number.
fundsource
: string The fundsource details.
customer_name
: string Name of the customer.
ifsc
: string IFSC code of the account linked to the VPA.
upi_iin
: string The UPI Issuer Identification Numbers (IIN) of the payment source provider issued by NPCI.
is_merchant_vpa
: boolean Indicates if the VPA is a business VPA.
true: VPA is a business VPA.false: VPA is not a business VPA.
is_merchant_verified
: boolean Indicates if the merchant is verified.
true: Merchant is verified.false: Merchant is not verified.
mcc
: string Merchant Category Code.
merchant
: object Merchant details.
identifier
: string Unique merchant identifiers.
mid
: string Merchant id.
sid
: string Sub-merchant id.
tid
: string Terminal id.
merchant_type
: string Type of merchant.
merchant_genre
: string Business vertical or segment.
onboarding_type
: string How the merchant was onboarded.
name
: object Merchant’s business and legal names.
brand
: string Merchant’s brand name.
legal
: string Merchant’s legal registered name.
franchise
: string Franchise name if applicable.
ownership
: object Merchant ownership details.
type
: string Type of ownership.
feature
: array List of special features tagged with this VPA.