Skip to main content

UPI Details

This API endpoint allows you to retrieve the UPI details for a specific merchant and product. The details returned will include key information about the merchant, the associated bank IDs, and member-related data. 

🔑Header Parameters

HeaderTypeDescriptionExample
AuthorizationstringBearer token for user authentication.{{access_token}}
x-api-keystringAPI key to authenticate the request.{{x-api-key}}
Content-TypestringSpecifies the type of the request payload.application/json

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringStatus of the API call."success"
codestringResponse code indicating the outcome of the request."s-101"
messagestringA message indicating the success of the request."Success message"
dataarray of objectArray containing the UPI details.see details below

🏛️ UPI Details (Array of Objects)

FieldTypeDescriptionExample/ENUM
sProductIdstringThe unique identifier for the product."2"
sMerchantIdstringThe unique identifier for the merchant.M67890
sMerchantNamestringThe name of the merchant.ABC Retailers
sMasterBankIdstringThe master bank ID associated with the merchant.MBID1234
sBankIdstringThe bank ID associated with the merchant.BID5678
sMappedBankIdstringThe mapped bank ID for transactions.MBID8765
sMemberLoginIdstringThe login ID for the merchant member.MLogin9876
sMemberPasswordstringThe password associated with the member login.Password123!
sMemberIdstringThe unique identifier for the merchant member.MID54321
nBlockThirdPartyintegerFlag indicating if third-party payments are blocked.1
sAggregatorBankIdstringThe bank ID for the aggregator.AGID1122
sMappedBankNamestringThe name of the mapped bank.XYZ Bank
nGroupIdintegerThe ID of the group to which the merchant belongs.35
get/transactional/v1/getUPIDetails/