get https://uat-partner.payu.in/api/api/v2/merchants/
The Get Merchant API is used to get the merchant details. You require the access token to get the merchant details using this API. The access token can be fetched using the Get Token API. For more information, refer to Get Token API.
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.
Environment
Test Environment | https://uat-partner.payu.in/ |
Production Environment | https://partner.payu.in/ |
Sample request
curl --location -g --request GET '{{partner_base_url}}/api/v1/merchants/7060013' \
--header 'Authorization: bearer {{access_token}}'
Sample response
Success scenario
{
"merchant": {
"name": "test7_6july20",
"email": "[email protected]",
"registered_mobile": "9466811031",
"mid": 7060013,
"product": "PayUmoney",
"business_type": "LongTail",
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"gst_number": null,
"created_at": "2020-07-06T12:58:17.000Z",
"mobile": "9466811031",
"blocked": false,
"first_name": "",
"last_name": "test7_6july20",
"bank_detail": {
"bank_account_number": null,
"ifsc_code": null,
"holder_name": null,
"nodal_code": null,
"nodal_status": "Not Activated"
},
"operating_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"registration_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"business_entity": null,
"status": "account_created",
"partner_source": "Create Merchant API",
"pan_verification_status": "Pending",
"website_approval_status": "Not Applicable",
"notification_email": "[email protected]",
"settlement_status": null,
"is_service_agreement_accepted": false,
"is_authorisation_letter_required": true,
"monthly_expected_volume": null,
"business_category": null,
"business_sub_category": null,
"bank_verification_status": null,
"penny_deposit_status": null,
"uuid": "11ea-bf88-5c1eb1f4-9363-0acb18027a2a",
"document_status": "Pending"
}
}
Failure Scenarios
- 401: Unauthorised request
{
"status": "Unauthorized"
}
- 404: When merchant was not referred by partner
{
"data": {
"message": "Invalid merchant mid"
}
}
- 422: When token is not of partner or not valid
"error": "Partner Not Found"
}
- 404: When merchant is not found:
{
"status": "NotFound"
}
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
curl --location -g --request GET '{{partner_base_url}}/api/v1/merchants/7060013' \
--header 'Authorization: bearer {{access_token}}'
curl --location -g --request GET '{{partner_base_url}}/api/v1/merchants/7060013' \
--header 'Authorization: bearer {{access_token}}'
Sample response
Success scenario
{
"merchant": {
"name": "test7_6july20",
"email": "[email protected]",
"registered_mobile": "9466811031",
"mid": 7060013,
"product": "PayUmoney",
"business_type": "LongTail",
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"gst_number": null,
"created_at": "2020-07-06T12:58:17.000Z",
"mobile": "9466811031",
"blocked": false,
"first_name": "",
"last_name": "test7_6july20",
"bank_detail": {
"bank_account_number": null,
"ifsc_code": null,
"holder_name": null,
"nodal_code": null,
"nodal_status": "Not Activated"
},
"operating_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"registration_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"business_entity": null,
"status": "account_created",
"partner_source": "Create Merchant API",
"pan_verification_status": "Pending",
"website_approval_status": "Not Applicable",
"notification_email": "[email protected]",
"settlement_status": null,
"is_service_agreement_accepted": false,
"is_authorisation_letter_required": true,
"monthly_expected_volume": null,
"business_category": null,
"business_sub_category": null,
"bank_verification_status": null,
"penny_deposit_status": null,
"uuid": "11ea-bf88-5c1eb1f4-9363-0acb18027a2a",
"document_status": "Pending"
}
}
Failure Scenarios
- 401: Unauthorised request
{
"status": "Unauthorized"
}
- 404: When merchant was not referred by partner
{
"data": {
"message": "Invalid merchant mid"
}
}
- 422: When token is not of partner or not valid
"error": "Partner Not Found"
}
- 404: When merchant is not found:
{
"status": "NotFound"
}
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
Success scenario
{
"merchant": {
"name": "test7_6july20",
"email": "[email protected]",
"registered_mobile": "9466811031",
"mid": 7060013,
"product": "PayUmoney",
"business_type": "LongTail",
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"gst_number": null,
"created_at": "2020-07-06T12:58:17.000Z",
"mobile": "9466811031",
"blocked": false,
"first_name": "",
"last_name": "test7_6july20",
"bank_detail": {
"bank_account_number": null,
"ifsc_code": null,
"holder_name": null,
"nodal_code": null,
"nodal_status": "Not Activated"
},
"operating_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"registration_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"business_entity": null,
"status": "account_created",
"partner_source": "Create Merchant API",
"pan_verification_status": "Pending",
"website_approval_status": "Not Applicable",
"notification_email": "[email protected]",
"settlement_status": null,
"is_service_agreement_accepted": false,
"is_authorisation_letter_required": true,
"monthly_expected_volume": null,
"business_category": null,
"business_sub_category": null,
"bank_verification_status": null,
"penny_deposit_status": null,
"uuid": "11ea-bf88-5c1eb1f4-9363-0acb18027a2a",
"document_status": "Pending"
}
}
Failure Scenarios
- 401: Unauthorised request
{
"status": "Unauthorized"
}
- 404: When merchant was not referred by partner
{
"data": {
"message": "Invalid merchant mid"
}
}
- 422: When token is not of partner or not valid
"error": "Partner Not Found"
}
- 404: When merchant is not found:
{
"status": "NotFound"
}
{
"merchant": {
"name": "test7_6july20",
"email": "[email protected]",
"registered_mobile": "9466811031",
"mid": 7060013,
"product": "PayUmoney",
"business_type": "LongTail",
"business_name": null,
"pancard_name": null,
"pancard_number": null,
"website_url": null,
"android_url": null,
"ios_url": null,
"gst_number": null,
"created_at": "2020-07-06T12:58:17.000Z",
"mobile": "9466811031",
"blocked": false,
"first_name": "",
"last_name": "test7_6july20",
"bank_detail": {
"bank_account_number": null,
"ifsc_code": null,
"holder_name": null,
"nodal_code": null,
"nodal_status": "Not Activated"
},
"operating_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"registration_address": {
"address_line": null,
"city": null,
"state": null,
"pincode": null
},
"business_entity": null,
"status": "account_created",
"partner_source": "Create Merchant API",
"pan_verification_status": "Pending",
"website_approval_status": "Not Applicable",
"notification_email": "[email protected]",
"settlement_status": null,
"is_service_agreement_accepted": false,
"is_authorisation_letter_required": true,
"monthly_expected_volume": null,
"business_category": null,
"business_sub_category": null,
"bank_verification_status": null,
"penny_deposit_status": null,
"uuid": "11ea-bf88-5c1eb1f4-9363-0acb18027a2a",
"document_status": "Pending"
}
}
{
"status": "Unauthorized"
}
{
"data": {
"message": "Invalid merchant mid"
}
}
"error": "Partner Not Found"
}
{
"status": "NotFound"
}
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
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