Retrieve list of available merchant statuses

API Endpoint: GET /api/export/GetAvailableStatusesList

Overview:

The GET /api/export/GetAvailableStatusesList API method retrieves a list of all available merchant statuses within the payment processing system. Merchant statuses reflect different stages or conditions of a merchant’s account, such as whether they are active, pending approval, suspended, or closed. This endpoint is used during the merchant onboarding and management process to provide relevant status options.

Purpose:

This endpoint allows ISOs, administrators, or boarding platforms to retrieve a comprehensive list of possible statuses for merchants. It is useful for onboarding workflows, status updates, or managing merchant accounts, ensuring that the correct status can be applied to a merchant's account at any point during its lifecycle.

HTTP Request Method:

• GET

URL:

• /api/export/GetAvailableStatusesList

Authentication:

• Required: Yes
• Authentication Method: Basic Token or API Key provided in the request header.

Request Headers:

• Authorization: Basic <token> (required) - Used to authenticate the API call.
• Content-Type: application/json (optional).

Query Parameters:

• None (the list of available merchant statuses is returned based on the authenticated user's access level or ISO configuration).

Success Response:

• Status Code: 200 OK
• Response Body (JSON format):
  JSON

  [
  {
    "id": 0,
    "name": "Not Submitted"
  },
  {
    "id": 1,
    "name": "Approved"
  },
  {
    "id": 2,
    "name": "Declined"
  },
  {
    "id": 3,
    "name": "UW Level 2: Pending"
  },
  {
    "id": 4,
    "name": "UW Level 1: Pending"
  },
  {
    "id": 22,
    "name": "Withdrawn"
  },
  {
    "id": 23,
    "name": "Closed"
  },
  {
    "id": 40,
    "name": "Conditionally Approved"
  },
  {
    "id": 100,
    "name": "UW Level 1"
  },
  {
    "id": 105,
    "name": "UW Level 2: Pending Review"
  },
  {
    "id": 106,
    "name": "UW Level 1: Pending Review"
  },
  {
    "id": 117,
    "name": "UW Level 2"
  },
  {
    "id": 206,
    "name": "CR:POS Equipment"
  }
  ]
  

Error Responses:

• 401 Unauthorized:
  • Occurs if the request lacks valid authentication credentials.
  • Response body:
    JSON

    {
      "error": "Unauthorized",
      "message": "Invalid or missing token"
    }
    

• 403 Forbidden:
  • Occurs if the API user does not have permission to access the list of merchant statuses.
  • Response body:
    JSON

    {
      "error": "Forbidden",
      "message": "You do not have permission to access this resource"
    }
    

• 404 Not Found:
  • Occurs if no merchant statuses are found.
  • Response body:
    JSON

    {
      "error": "Not Found",
      "message": "No merchant statuses available"
    }
    

Notes:

• The list of available merchant statuses may vary depending on the system configuration or the ISO accessing the API.
• This endpoint helps streamline the merchant onboarding and account management process by providing standardized status options.