API Method: GET /api/v1/merchant/siteInspection
GET /api/v1/merchant/siteInspection
Description:
This API endpoint retrieves the details of a merchant's site inspection, which is an integral part of the merchant onboarding process in payment processing services. A site inspection is typically performed to assess the merchant's physical or online business presence to ensure compliance with the regulations and standards required by the payment processor. The API returns information about the status and findings of the site inspection, such as whether the merchant's business site was approved, pending, or rejected.
Request:
- HTTP Method:
GET
- Endpoint:
/api/v1/merchant/siteInspection
Request Parameters:
- merchantId (required,
string
): The unique identifier of the merchant whose site inspection details are being requested.
Example Request:
GET /api/v1/merchant/siteInspection?merchantId=123456
Response:
The API returns a JSON object containing the details of the merchant's site inspection.
Error Responses:
- 400 Bad Request: Returned if the
merchantId
parameter is missing or invalid. - 404 Not Found: Returned if no site inspection details are found for the specified
merchantId
. - 500 Internal Server Error: Returned in case of a server-side issue.
Use Case:
This API is typically used by merchant service providers, risk management teams, or support agents to check the status of a merchant's site inspection as part of the overall onboarding or review process.