Onboarding Child Merchants APIs

Onboarding Child Merchants

The steps involved in creating a child merchant are:

  1. Get Client Token API
  2. Create Child Merchant API

📘

Note:

Before you onboard child merchants, ensure you have followed the Prerequisites (one-time).

Domains

Common Onboarding

UAT Environmenthttps://uat-onepayuonboarding.payu.in
Production Environmenthttps://onboarding.payu.in

Hub Service Domains

UAT Environmenthttps://uat-accounts.payu.in
Production Environmenthttps://accounts.payu.in

Prerequisites

Before you onboard child merchants, you need to ensure the following (one-time process):

  • Caller client service should be registered on Hub (PayU’s oAuth2 Service ) with the details as described in the following table:
FieldDescription
Customer NameThe legal name of the customer.
Customer Service NameThe service name of the customer.
Customer Owner phone numberThe phone number of the owner who is assigned for the customer.
Customer Owner EmailThe customer owner’s email ID.
ScopesThe scope to be whitelisted on the client must be refer_child_merchant
Grant typeThe grant type must be specified as client_credentials in this field.
Client typeProvide External as input since you are outside the PayU ecosystem.
Access Token Expiry TimeThe access token expiry time from the times of creation (in seconds). There is no defined limit for configuring the access token expiry time.
  • refer_child_merchant scope should be whitelisted on caller client on Hub
  • Get Aggregator flag enabled on the parent merchant

Step 1: Get client token

Use the get_client_token API with the scope as refer_child_merchant to create a client token from Hub. For more information, refer to Get Client Token API

Step 2: Create a child merchant

You can create child merchants using the create_child_merchant API. For more information, refer to Create Child Merchant API

After you onboard your child merchants, you can fetch the child merchant details as described in the following API reference: