Fetch Masked VPAs API

The fetchMaskedVpa API is used to fetch the list of masked UPI IDs against any mobile number.

HTTP Method: POST

Environment

Test Environmenthttps://uatoneapi.payu.in/payout/payment/fetchMaskedVpa
Production Environmenthttps://payout.payumoney.com/payout/payment/fetchMaskedVpa

Header parameters

ParameterDescriptionExample
Authorization mandatoryStringSpecify the access token generated during authentication in this parameter.Bearer {access_token}
payoutMerchantId
mandatory		StringSpecify the merchant ID provided while onboarding for Payouts in this parameter.1111126
Content-Type mandatoryStringIndicates the format in which the request is sent.application/x-www-form-urlencoded

📘

Note:

The payoutMerchantId is different from PayU Merchant Id. Check the Payouts Dashboard or call the PayU Customer Support if you don’t know your payoutMerchantId.

Request parameters

ParametersDescriptionExample
mobileNumber
mandatory		StringIndicates the mobile number of the beneficiary9999999999

Sample request

curl --location --request GET 'https://test.payumoney.com/payout/payment/fetchMaskedVpa?mobileNumber=1234567890' \
--header 'Authorization: Bearer 0f8188bfdf6ff8c630376c63497f3745ff3e21b9dfdc9a4955b4561cec9bb05e' \
--header 'payoutMerchantId: 2222740' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: Path=/; Path=/' \
--data-urlencode 'mobileNumber=1234567890'

Response parameters

ParameterDescription
statusThis parameter returns the status of web service call. The status can be any of the following:
- 0 - If web service call succeeded
- 
1 - If web service call failed
msgThis parameter returns the success or failure message.
codeThis parameter returns the error code if the API failed to verify or invalid details.
dataThis parameter returns the saved card details in a JSON format. For more information, refer to the next table.

Description of data JSON fields

FieldDescription
resultThe version of the results displayed for this API.
VPA IDThis field returns the following details in an array format:
- Token: The token for the VPA. For example, "13e3a8caa1ede3c56a524"
- name: The name of the account holder.
- App_Name: The name of the UPI provider through which the UPI is used by beneficiary. For example, Google Pay

Sample response

  • Success response
{
    "status": 0,
    "msg": null,
    "code": null,
    "data": {
        "result": 1.0,
        "9x1x3x5x8x@okaxis": {
            "Token": "13e3a8caa1ede3c56a524",
            "name": "",
            "App_Name": "Google Pay"
        },
        "9x3x5x0x9x@ybl": {
            "Token": "291dc5886ed5a13f50ccd",
            "name": "Sajan Bhadrike ",
            "App_Name": "PhonePe"
        }
    }
}
  • Failure response
  • {
    "status": 0,
    "msg": null,
    "code": null,
    "data": null
}