Get list of UW tasks of the merchant

API Method: GET /api/v1/uwTasks/getByMerchantId

Description:

This API endpoint retrieves a list of Underwriting (UW) tasks associated with a specific merchant. Underwriting tasks refer to the steps or actions that need to be completed as part of the merchant's onboarding process, including risk assessment, compliance checks, and other relevant verifications. This endpoint provides a detailed list of all pending, completed, or in-progress tasks related to underwriting for a merchant.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/uwTasks/getByMerchantId
• Content-Type: application/json

Request Parameters:

The request should include the following parameter:

• ID (required):
  The unique identifier of the merchant for whom the UW tasks are being retrieved.
  • Type: int32
  • Example: ID=12345

Response:

• Status Code:

  • 200 OK: If the list of UW tasks is successfully retrieved.
  • 400 Bad Request: If the merchant ID is missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response includes a list of UW tasks for the merchant, with details such as task status (pending, completed), task description, and deadlines if applicable.

Example Request:

GET /api/v1/uwTasks/getByMerchantId?ID=12345

Example Response:

{
  "tasks": [
    {
      "taskId": 101,
      "description": "Verify business registration",
      "status": "completed",
      "dueDate": "2024-09-15"
    },
    {
      "taskId": 102,
      "description": "Submit bank statements",
      "status": "pending",
      "dueDate": "2024-10-20"
    }
  ]
}

Use Case:

This API method is used by ISO/ISV or administrators to track the progress of underwriting tasks for a specific merchant. It helps in monitoring which tasks have been completed and which are still pending, ensuring that the underwriting process is on track for the merchant’s application approval.