post https://uat-partner.payu.in/api/v3/merchants
The Create Merchant API is used to:
- Create a new merchant account on PayU and post all KYC details
- Returns the Merchant ID (mid) in the response.
This API is authorised through a client token generated using the client ID and secret.
Note:
The access token with the scope as refer_merchant is required on the header. For more information on getting the access token, refer to Get Token API.
Sample response
{
"merchant": {
"name": "test",
"email": "[email protected]",
"registered_mobile": "9999910014",
"mid": 129463,
"product": "PayUbiz",
"business_type": "LongTail",
"business_name": "Test",
"pancard_name": "Test",
"pancard_number": "ABCPG1234J",
"cin_number":"U72400MH2006PTC293037",
"website_url": null,
"android_url": null,
"ios_url": null,
"gst_number": null,
"created_at": "2020-12-08T11:03:56.000Z",
"mobile": "9999910014",
"blocked": false,
"first_name": "",
"last_name": "test",
"bank_detail": {
"bank_account_number": "234567891",
"ifsc_code": "ICIC0000734",
"holder_name": "Test"
},
"operating_address": {
"address_line": "operational addr",
"city": "Sant Ravidas Nagar",
"state": "UTTAR PRADESH",
"pincode": 221304
},
"registration_address": {
"address_line": "busenaddres line",
"city": "Sant Ravidas Nagar",
"state": "UTTAR PRADESH",
"pincode": 221303
},
"business_entity": "LLP",
"status": "account_created",
"partner_source": "Create Merchant API",
"pan_verification_status": "Pending",
"website_approval_status": "Pending",
"notification_email": "[email protected]",
"settlement_status": null,
"is_service_agreement_accepted": false,
"is_authorisation_letter_required": false,
"monthly_expected_volume": 120000,
"business_category": "Ecommerce",
"business_sub_category": "Flowers and Gifts",
"bank_verification_status": "Pending",
"uuid": "11eb-3945-0fcf623a-86d9-026e3e71538e",
"penny_deposit_status": "Not Initiated",
"signing_authority": {
"name": "test_auth",
"email": "[email protected]"
},
"director1_details": {
"name": "test1_dir",
"email": "[email protected]"
},
"director2_details": {
"name": "test2_dir",
"email": "[email protected]"
}
}
}
Response parameters
Parameter Description merchant This parameter contains the following details of the merchant in an array format. business_entity This parameter contains the business entity of the merchant that was provided while onboarding. status This parameter contains any of the following statuses:
β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected
partner_source This parameter returns the source through which the merchant joined or onboarded. pan_verification_status This parameter contains any of the following PAN verification statuses:
β’ Success
β’ Pending
β’ Failed website_approval_status This parameter contains any of the following website approval statuses:
β’ Website Not live
β’ Website Incomplete
β’ Website Under Construction
β’ Website Error
β’ Website OK
β’ Verification in Process notification_email This parameter contains the email to which the notification was sent to the merchant on onboarding. settlement_status This parameter contains any of the following settlement statuses:
β’ Risk Hold β’ Thirdparty Hold β’ Active β’ Suspended β’ Risk & Thirdparty hold β’ NEFT Return β’ Terminate
is_service_agreement_accepted This parameter contains the flag whether the service agreement was accepted or not. is_authorisation_letter_required This parameter contains the flag whether the authorization letter is required or not required. monthly_expected_volume This parameter contains the monthly expected volume from the merchant. business_category This parameter contains the business category of the merchant that was provided while onboarding. business_sub_category This parameter contains the business sub-category of the merchant that was provided while onboarding. bank_verification_status This parameter contains any of the following bank verification statuses:
β’ Pending β’ Success β’ Verification Attempts Exhausted β’ Failed
penny_deposit_status This parameter contains any of the following penny deposit statuses when bank account verification was performed:
β’ Not Initiated β’ Pending β’ SENT_TO_BANK β’ Success β’ Failed
uuid This parameter contains the Universal Unique Identifier (UUID). document_status This parameter contains the document status and can be any of the following:
β’ Pending: It indicates that document not yet submitted
β’ Docs Received: It indicates that documents are submitted
β’ Docs Approved: It indicates that documents are approved
β’ Docs Error: It indicates that mismatch in data or wrong document
Request Parameters
Reference information for request parameters
Parameter Reference merchant[business_details][business_category] For the list of business categories, refer to Business. Category List. merchant[business_details][business_entity_type] For the list of business entity type, refer to Business Entity Type. merchant[business_details][business_sub_category] For the list of business subcategories, refer to Business Sub-Category.
Parameter Description merchant This parameter contains the following details of the merchant in an array format. business_entity This parameter contains the business entity of the merchant that was provided while onboarding. status This parameter contains any of the following statuses:
β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected
partner_source This parameter returns the source through which the merchant joined or onboarded. pan_verification_status This parameter contains any of the following PAN verification statuses:
β’ Success
β’ Pending
β’ Failed website_approval_status This parameter contains any of the following website approval statuses:
β’ Website Not live
β’ Website Incomplete
β’ Website Under Construction
β’ Website Error
β’ Website OK
β’ Verification in Process notification_email This parameter contains the email to which the notification was sent to the merchant on onboarding. settlement_status This parameter contains any of the following settlement statuses:
β’ Risk Hold β’ Thirdparty Hold β’ Active β’ Suspended β’ Risk & Thirdparty hold β’ NEFT Return β’ Terminate
is_service_agreement_accepted This parameter contains the flag whether the service agreement was accepted or not. is_authorisation_letter_required This parameter contains the flag whether the authorization letter is required or not required. monthly_expected_volume This parameter contains the monthly expected volume from the merchant. business_category This parameter contains the business category of the merchant that was provided while onboarding. business_sub_category This parameter contains the business sub-category of the merchant that was provided while onboarding. bank_verification_status This parameter contains any of the following bank verification statuses:
β’ Pending β’ Success β’ Verification Attempts Exhausted β’ Failed
penny_deposit_status This parameter contains any of the following penny deposit statuses when bank account verification was performed:
β’ Not Initiated β’ Pending β’ SENT_TO_BANK β’ Success β’ Failed
uuid This parameter contains the Universal Unique Identifier (UUID). document_status This parameter contains the document status and can be any of the following:
β’ Pending: It indicates that document not yet submitted
β’ Docs Received: It indicates that documents are submitted
β’ Docs Approved: It indicates that documents are approved
β’ Docs Error: It indicates that mismatch in data or wrong document
Parameter | Description |
---|---|
merchant | This parameter contains the following details of the merchant in an array format. |
business_entity | This parameter contains the business entity of the merchant that was provided while onboarding. |
status | This parameter contains any of the following statuses:β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected β’ documents_pending β’ bank_verified β’ document_upload_in_progress β’ account_created β’ document_verification_in_progress β’ website_verification_in_progress β’ documents_rejected β’ live β’ settlement_on_hold β’ agreement_pending β’ agreement_rejected β’ not_available β’ website_error β’ profile_rejected |
partner_source | This parameter returns the source through which the merchant joined or onboarded. |
pan_verification_status | This parameter contains any of the following PAN verification statuses: β’ Success β’ Pending β’ Failed |
website_approval_status | This parameter contains any of the following website approval statuses: β’ Website Not live β’ Website Incomplete β’ Website Under Construction β’ Website Error β’ Website OK β’ Verification in Process |
notification_email | This parameter contains the email to which the notification was sent to the merchant on onboarding. |
settlement_status | This parameter contains any of the following settlement statuses:β’ Risk Hold β’ Thirdparty Hold β’ Active β’ Suspended β’ Risk & Thirdparty hold β’ NEFT Return β’ Terminate |
is_service_agreement_accepted | This parameter contains the flag whether the service agreement was accepted or not. |
is_authorisation_letter_required | This parameter contains the flag whether the authorization letter is required or not required. |
monthly_expected_volume | This parameter contains the monthly expected volume from the merchant. |
business_category | This parameter contains the business category of the merchant that was provided while onboarding. |
business_sub_category | This parameter contains the business sub-category of the merchant that was provided while onboarding. |
bank_verification_status | This parameter contains any of the following bank verification statuses:β’ Pending β’ Success β’ Verification Attempts Exhausted β’ Failed |
penny_deposit_status | This parameter contains any of the following penny deposit statuses when bank account verification was performed:β’ Not Initiated β’ Pending β’ SENT_TO_BANK β’ Success β’ Failed |
uuid | This parameter contains the Universal Unique Identifier (UUID). |
document_status | This parameter contains the document status and can be any of the following: β’ Pending: It indicates that document not yet submitted β’ Docs Received: It indicates that documents are submitted β’ Docs Approved: It indicates that documents are approved β’ Docs Error: It indicates that mismatch in data or wrong document |
Request Parameters
Reference information for request parameters
Parameter | Reference |
---|---|
merchant[business_details][business_category] | For the list of business categories, refer to Business. Category List. |
merchant[business_details][business_entity_type] | For the list of business entity type, refer to Business Entity Type. |
merchant[business_details][business_sub_category] | For the list of business subcategories, refer to Business Sub-Category. |