Retrieve list of equipment funders for terminal boarding

API Endpoint: GET /api/v1/equipment/funders

Overview:

The GET /api/v1/equipment/funders API method retrieves a list of equipment funders available for terminal boarding in the payment processing service. Equipment funders provide the necessary financial support for merchants to acquire payment terminals or related equipment, and this endpoint allows ISOs or boarding platforms to access the list of available funders when boarding a terminal for a merchant.

Purpose:

This endpoint is used to retrieve a list of approved equipment funders that can be selected during the terminal boarding process. It allows ISOs, merchants, or administrators to choose the appropriate funder when setting up or financing payment terminals for merchants, ensuring that the terminal equipment is funded through an authorized source.

HTTP Request Method:

• GET

URL:

• /api/v1/equipment/funders

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 equipment funders is returned based on the authenticated user's ISO or system configuration).

Success Response:

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

  {
  "data": [
    {
      "id": 1,
      "name": "Unified Payments"
    },
    {
      "id": 2,
      "name": "Phoenix Fusion"
    },
    {
      "id": 3,
      "name": "RPS"
    },
    {
      "id": 4,
      "name": "Super PC Systems"
    },
    {
      "id": 5,
      "name": "ISO office"
    }
  ],
  "status": 200
  }
  

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 equipment funders.
  • Response body:
    JSON

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

• 404 Not Found:
  • Occurs if no equipment funders are available for terminal boarding.
  • Response body:
    JSON

    {
      "error": "Not Found",
      "message": "No equipment funders found"
    }
    

Notes:

• The list of equipment funders is specific to the terminal boarding process, and each funder may have different terms and services for funding payment terminals.
• The API user must be authenticated to retrieve the list, and only funders approved for the user's ISO will be returned.