The Sub Account Listing API fetches all child merchant details linked to a parent merchant. You must pass the parent merchant MID for the parent_merchant_uuid parameter in this request.
HTTP Method: GET
Environment
| Test Environment | <https://uat-onepayuonboarding.payu.in> |
| Production Environment | <https://onboarding.payu.in> |
Reference: You must use the Get Access Token API with the scope as fetch_child_merchants to get the token that must be passed in header.
Post parameters
| Parameter | Parameter Type | Description |
|---|---|---|
parent_merchant_uuid |
Path |
This parameter must contain the parent merchant MID. |
Authorization |
Query |
Merchant access token or client token with the scope as fetch_child_merchants from Hub. Bearer {{access_token}} For more information, refer to Sub Account Listing API |
search_term |
Query |
This parameter must contain any of the following search term:
|
search_text |
Query |
|
Sample request
Success scenario
curl --location '{{onboarding_base_url}}/api/v3/product_accounts/{{product_account_uuid}}/sub_accounts?search_term=email&search_text=abcpayu.in' \
--header 'Authorization: Bearer {{access_token}}' Failure Scenario
curl --location -g --request GET '{{onboarding_base_url}}/api/v3/product_accounts/{{mid}}/sub_accounts' \
--header 'Authorization: Bearer {{access_token}}'Response Parameters
| Parameter | Description |
|---|---|
id |
The ID of the child merchant |
mid |
The mid of the child merchant |
uuid |
The uuid (Universally unique identifier) of the child merchant |
product |
This parameter must be passed with the following value: "PayUBiz" |
device |
The app device used by child merchant to sell the products. |
business_type |
Business type of the child merchant. |
quality_score |
Quality score of the child merchant based on the verification by PayU. |
display_name |
The display name of the child merchant |
account_id |
Account ID of the child merchant. |
business_entity_id |
The business entity ID of the merchant. The business entity ID and corresponding business entity is listed in the Partner Category List table of this section. |
business_category_id |
The business category ID of the merchant. |
business_sub_category_id |
The business sub category ID of the merchant. |
business_name |
Business name of the merchant, similar to PAN. |
pancard_name |
Name of the child merchant as in the PAN card. |
pancard_number |
PAN card number of the child merchant. |
website_url |
Website URL of the child merchant |
ios_url |
IOS app URL of the merchant. |
business_origin |
Business origin of the merchant., |
gst_number |
GST number of the merchant registered with the Sales tax department. |
integration_type |
The integration type of the merchant. It can be any of the following:
|
routing_mid |
Routing MID is displayed in this parameter |
average_delivery_time |
Average delivery time of the merchant |
downjones_check |
Downjones check details by PayU |
aggregator_type |
Aggregator type for the child merchant |
monthly_expected_volume |
Monthly expected volume of the child merchant. |
campaign_name |
Campaign name through which the child merchant joined. |
campaign_medium |
Campaign medium through which the child merchant joined. |
campaign_source |
Campaign source through which the child merchant joined. |
campaign_term |
Campaign period of the campaign through which the child merchant joined. |
partner_uuid |
Parent partner UUID of the child merchant |
created_at |
Child merchant creation timestamp |
updated_at |
Child merchant details last updated time stamp. |
admin_user_id |
Admin user ID of the child merchant. |
The child merchant email. |
|
mobile |
Mobile number of the child merchant |
terms_and_condition_accepted_at |
Timestamp when the Terms and Conditions was accepted by the child merchant. |
website_approval_statu |
Website approval status of the child merchant |
sub_source |
Sub source of the child merchant. |
account_uuid |
Account UUID of the child merchant. |
pan_verification_status |
PAN card verification status of the child merchant. |
website_remarks |
Website verification remarks by PayU. |
settlement_status |
Last settlement status of the child merchant. |
source_details |
Source details of the child merchant. |
merchant_vertical |
Child merchant business vertical. |
notification_email |
Email ID of the child merchant to which the notifications need to be sent by PayU |
bank_update_attempt_count |
Was the bank update attempt was successful by PayU |
partner_source |
Partner source of the child merchant |
integration_status |
Integration status of the child merchant |
merchant_type |
Merchant type will have the value as "Aggregator." |
child_aggregator |
Child aggregator if any of the current child merchant. |
shop_number |
Shop telephone number of the child merchant. |
area_code |
Area code of the child merchant. |
Sample Response
Success Scenario
- When they are searching using date range:
{
"child_merchants": {
"product_accounts": [
{
"uuid": "11f0-badd-c184cc6c-8834-02975f21d323",
"created_at": "2025-11-06T06:56:45.000Z",
"name": null,
"mid": 30949833,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "kjvbjs324",
"product_account_detail": {
"pg_key": "zuHLVs"
}
},
{
"uuid": "11f0-b3c3-7b4e4f82-9891-02975f21d323",
"created_at": "2025-10-28T06:01:02.000Z",
"name": null,
"mid": 30949599,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "khxBZY"
}
},
{
"uuid": "11f0-b2fe-eb006fe2-9095-02975f21d323",
"created_at": "2025-10-27T06:33:58.000Z",
"name": null,
"mid": 30949595,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "Vm9b40"
}
},
{
"uuid": "11f0-b2fe-3c5fb7c2-9886-02975f21d323",
"created_at": "2025-10-27T06:29:05.000Z",
"name": null,
"mid": 30949594,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "7uHKyT"
}
},
{
"uuid": "11f0-aa65-5517cda0-be46-02975f21d323",
"created_at": "2025-10-16T07:54:24.000Z",
"name": "ESSERE DONNA PRIVATE LIMITED",
"mid": 30949575,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "26ooZx"
}
},
{
"uuid": "11f0-a991-ed793216-af6c-02975f21d323",
"created_at": "2025-10-15T06:41:09.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949571,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "RHFU4739479347",
"product_account_detail": {
"pg_key": "lsjhaK"
}
},
{
"uuid": "11f0-a5b9-5584539a-a070-02975f21d323",
"created_at": "2025-10-10T09:13:09.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949564,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "YF749347fh7",
"product_account_detail": {
"pg_key": "6qRbp7"
}
},
{
"uuid": "11f0-a511-2abc3414-aa2c-02975f21d323",
"created_at": "2025-10-09T13:09:21.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949562,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "Vib473948h",
"product_account_detail": {
"pg_key": "FBD9kH"
}
},
{
"uuid": "11f0-a50e-20468b40-9ce5-02975f21d323",
"created_at": "2025-10-09T12:47:36.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949561,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "hrth5343",
"product_account_detail": {
"pg_key": "Q5bBFY"
}
},
{
"uuid": "11f0-a50d-25ca373e-8286-02975f21d323",
"created_at": "2025-10-09T12:40:35.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949560,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "7505385",
"product_account_detail": {
"pg_key": "lUwaI1"
}
},
{
"uuid": "11f0-a508-6794909c-ab71-02975f21d323",
"created_at": "2025-10-09T12:06:38.000Z",
"name": "PAYU PAYMENTS PRIVATE LIMITED",
"mid": 30949559,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "syguyg8628",
"product_account_detail": {
"pg_key": "vWXP0L"
}
},
{
"uuid": "11f0-a506-172aff44-9d62-02975f21d323",
"created_at": "2025-10-09T11:50:05.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949558,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "izWaWz"
}
},
{
"uuid": "11f0-a4f6-1bd6a116-a645-02975f21d323",
"created_at": "2025-10-09T09:55:41.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949557,
"email": "[email protected]",
"onboarding_completed": true,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "HYBdoP"
}
},
{
"uuid": "11f0-a4df-3828c432-9938-02975f21d323",
"created_at": "2025-10-09T07:11:48.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949556,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "q3qskb"
}
},
{
"uuid": "11f0-a4d8-8664b3b0-9938-02975f21d323",
"created_at": "2025-10-09T06:23:56.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949555,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "lqZCjz"
}
},
{
"uuid": "11f0-a432-0cf67000-b4b1-02975f21d323",
"created_at": "2025-10-08T10:32:12.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949549,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "uVflCt"
}
},
{
"uuid": "11f0-a42b-f7f97072-b68d-02975f21d323",
"created_at": "2025-10-08T09:48:42.000Z",
"name": "AYANTIKA PRAMANICK",
"mid": 30949547,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": null,
"product_account_detail": {
"pg_key": "djHFIE"
}
}
]
},
"total_childs": 17
}- When using the merchant defined identifier:
{
"child_merchants": {
"product_accounts": [
{
"uuid": "11f0-badd-c184cc6c-8834-02975f21d323",
"created_at": "2025-11-06T06:56:45.000Z",
"name": null,
"mid": 30949833,
"email": "[email protected]",
"onboarding_completed": false,
"merchant_defined_identifier": "kjvbjs324",
"product_account_detail": {
"pg_key": "zuHLVs"
}
}
]
},
"total_childs": 1
}Failure Scenarios
Get Child merchants when token is invalid or expired
{
"status": "Unauthorized"
}