Create Merchant API

The Create Merchant API creates a new merchant account on PayU and posts all KYC details. This API returns the Merchant ID (MID) in the response.

Authentication

This API is authorised through a client token generated using the client ID and secret. To create a token, call the get token API with refer merchant as a scope. Refer to the Get Token API doc for more information.

❗️

Important considerations for using this API

  1. The mobile, Pan number, GSTIN passed in the request has to be valid as checks are performed in real time.
  2. If Business Entity type is passed in the create merchant API, ensure that the PAN also belong to the same entity.

Sample response

Success scenario

{
  "merchant": {
    "mid": "8390925",
    "kyc_document_name": "PAN Card of Signing Authority",
    "kyc_document_uuid": "11ef-587e-43837330-95b0-021ec077a271",
    "kyc_document_status": "DOCUMENT_SUBMITTED",
    "error_message": null,
    "created_at": "2024-08-12T07:41:19.000Z"
  }
}

Failure scenario

  • Duplicate merchant or merchant already exists
{
  "errors": {
    "error": [
      "Account already exists for given user"
    ]
  },
  "product_account": {
    "identifier": 8245177,
    "product": "PayUbiz"
  }
}

Response parameters

Fields in the merchant object

ParameterDescriptionExample
midUnique merchant identifier8390925
kyc_document_nameName of the KYC document categoryPAN Card of Signing Authority
kyc_document_uuidUnique identifier for the KYC document submission11ef-587e-43837330-95b0-021ec077a271
kyc_document_statusCurrent status of the KYC document (e.g., DOCUMENT_SUBMITTED, VERIFIED, REJECTED)DOCUMENT_SUBMITTED
error_messageError message if document verification failed, null otherwisenull
created_atTimestamp when the KYC document was created/submitted.2024-08-12T07:41:19.000Z

📘

Notes:

  • The kyc_document_status field can have the following values:
    • DOCUMENT_SUBMITTED: Document has been submitted but not yet verified
    • VERIFIED: Document has been verified and approved
    • REJECTED: Document was rejected during verification
    • PENDING: Document is pending verification
  • The error_message field will only contain a value if the document was rejected or there was an issue with the submission.
  • All timestamps are in ISO 8601 format with UTC timezone.

Request parameters

Reference information for request parameters
ParameterReference
merchant[business_category]For the list of business categories, refer to Business. Category List.
merchant[business_entity_type]For the list of business entity type, refer to Business Entity Type.
merchant[business_sub_category]For the list of business subcategories, refer to Business Sub-Category.
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!