The Sub Account Listing API fetches all child merchant details linked to a parent merchant. You must pass the UUID in this request.
HTTP Method: GET
Environment
| Test Environment | https://uat-onepayuonboarding.payu.in |
| Production Environment | https://onboarding.payu.in |
Post parameters
| Parameter | Description |
|---|---|
| Authorization | Bearer {{access_token}} |
| Merchant access token or client token with the scope as fetch_child_merchants from Hub. |
Sample request
Success scenario
curl --location -g --request GET '{{onboarding_base_url}}/api/v1/merchants/{{parent_merchant_uuid}}/sub_accounts' \
--header 'Authorization: Bearer {{access_token}}'
Failure Scenario
curl --location -g --request GET '{{onboarding_base_url}}/api/v1/merchants/{{parent_merchant_uuid}}/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: - Non-Seamless - Seamless - Not Selected |
| 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
Get Child Merchants - Success Scenario
{ // List of child merchant and their details under a parent merchant
"child_merchants": [
{
"id": 13044,
"mid": 7220715,
"test_mid": null,
"uuid": "11ec-1c34-13ba0648-b4c9-02053299b2da",
"product": "PayUmoney",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "PayUmoney",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-09-23T06:04:15.000Z",
"updated_at": "2021-09-23T06:04:15.000Z",
"admin_user_id": 9952,
"email": "[email protected]",
"mobile": "8860898210",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13045,
"mid": 7220716,
"test_mid": null,
"uuid": "11ec-1c34-8946c6a8-b4c9-02053299b2da",
"product": "PayUmoney",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "PayUmoney",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-09-23T06:07:31.000Z",
"updated_at": "2021-09-23T06:07:31.000Z",
"admin_user_id": 9953,
"email": "[email protected]",
"mobile": "8860890280",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13046,
"mid": 7220717,
"test_mid": null,
"uuid": "11ec-1c35-3684eda4-b4c9-02053299b2da",
"product": "PayUmoney",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "PayUmoney",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-09-23T06:12:21.000Z",
"updated_at": "2021-09-23T06:12:21.000Z",
"admin_user_id": 9954,
"email": "[email protected]",
"mobile": "8860890281",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13047,
"mid": 8006683,
"test_mid": null,
"uuid": "11ec-1c35-4c1bf900-b4c9-02053299b2da",
"product": "PayUbiz",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "SMB-ENT",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-09-23T06:12:58.000Z",
"updated_at": "2021-09-23T06:12:58.000Z",
"admin_user_id": 9955,
"email": "[email protected]",
"mobile": "8860890282",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13048,
"mid": 8006684,
"test_mid": null,
"uuid": "11ec-1c36-066b0ee0-b4c9-02053299b2da",
"product": "PayUbiz",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "SMB-ENT",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-09-23T06:18:11.000Z",
"updated_at": "2021-09-23T06:18:11.000Z",
"admin_user_id": 9956,
"email": "[email protected]",
"mobile": "8860890284",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13130,
"mid": 8006726,
"test_mid": null,
"uuid": "11ec-29d9-1753523e-a0b8-02053299b2da",
"product": "PayUbiz",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "SMB-ENT",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-10-10T14:48:25.000Z",
"updated_at": "2021-10-10T14:48:25.000Z",
"admin_user_id": 10049,
"email": "[email protected]",
"mobile": "8860890285",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
},
{
"id": 13131,
"mid": 8006727,
"test_mid": null,
"uuid": "11ec-29e1-9b1030da-a0b8-02053299b2da",
"product": "PayUbiz",
"device": "Other",
"business_type": "LongTail",
"quality_score": null,
"display_name": "Merchant",
"account_id": null,
"business_entity_id": null,
"business_category_id": null,
"business_sub_category_id": null,
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"business_origin": "SMB-ENT",
"gst_number": null,
"integration_type": "Not Selected",
"routing_mid": null,
"average_delivery_time": null,
"downjones_check": null,
"aggregator_model": null,
"aggregator_type": null,
"monthly_expected_volume": null,
"sap_id": null,
"source_type": null,
"active": true,
"source_url": null,
"campaign_name": null,
"campaign_medium": null,
"campaign_source": null,
"campaign_term": null,
"partner_uuid": null,
"created_at": "2021-10-10T15:49:14.000Z",
"updated_at": "2021-10-10T15:49:14.000Z",
"admin_user_id": 10050,
"email": "[email protected]",
"mobile": "8860890286",
"terms_and_condition_accepted_at": null,
"website_approval_status": null,
"sub_source": null,
"account_uuid": null,
"blocked": false,
"pan_verification_status": "Pending",
"website_remarks": null,
"settlement_status": null,
"source_details": null,
"merchant_vertical": null,
"notification_email": "[email protected]",
"bank_update_attempt_count": 0,
"partner_source": null,
"flag": 32,
"integration_status": "Not Integrated",
"merchant_type": "child_aggregator",
"gmv_amount": null,
"shop_number": null,
"area_code": null
}
]
}
Failure Scenarios
Get Child merchants when token is invalid or expired
{
"status": "Unauthorized"
}