Add POS equipment to the merchant application

API Method: POST /api/v1/equipment/equipmentpos

Description:

This API endpoint allows the addition of POS (Point-of-Sale) equipment to a merchant's application. Merchants or administrators can use this method to specify the POS equipment that will be used for payment processing. This includes defining the equipment type, purchase details, payment method, and other related information.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/equipment/equipmentpos
• Content-Type: application/json

Request Body Parameters:

The request body must be in JSON format and include the following fields:

• id (required):
  The unique identifier of the merchant or the application for which the POS equipment is being added.

  • Type: int32
  • Example: "id": 12345

• purchaseId (optional):
  The identifier for the purchase associated with the equipment. This can be used to link the equipment to a specific purchase transaction.

  • Type: int32
  • Example: "purchaseId": 67890

• equipmentId (required):
  The unique identifier for the specific POS equipment being added.

  • Type: int32
  • Example: "equipmentId": 112233

• quantity (required):
  The number of units of the POS equipment being added. The value must be between 1 and 10.

  • Type: int32
  • Example: "quantity": 2

• purchasePrice (optional):
  The purchase price of the POS equipment.

  • Type: double
  • Example: "purchasePrice": 499.99

• monthlyPayment (optional):
  The monthly payment amount for the POS equipment if applicable (e.g., for leased or financed equipment).

  • Type: double
  • Example: "monthlyPayment": 29.99

• paymentType (required):
  The type of payment method used for the equipment (e.g., "purchase", "lease", "rental").

  • Type: string
  • Example: "paymentType": "purchase"

• note (optional):
  Any additional notes or comments regarding the POS equipment.

  • Type: string
  • Example: "note": "This is a high-performance terminal"

• fundersIds (optional):
  An array of funder IDs associated with the POS equipment, if applicable. These funders might be external entities providing financing for the equipment.

  • Type: array of int32
  • Example: "fundersIds": 1001

Response:

• Status Code:

  • 201 Created: If the POS equipment is successfully added.
  • 400 Bad Request: If required fields are missing or invalid (e.g., quantity out of range).
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  A confirmation message or details of the newly added POS equipment.

Example Request:

POST /api/v1/equipment/equipmentpos
Content-Type: application/json

{
  "id": 12345,
  "purchaseId": 67890,
  "equipmentId": 112233,
  "quantity": 2,
  "purchasePrice": 499.99,
  "monthlyPayment": 29.99,
  "paymentType": "purchase",
  "note": "This is a high-performance terminal",
  "fundersIds": 1001, 
}

Use Case:

This API method is used by ISO/ISV or administrators to add and configure POS equipment within a merchant application. It allows for tracking the equipment's purchase or leasing details, specifying the quantity, and including relevant payment information. This endpoint is essential for merchants setting up or expanding their POS infrastructure for processing payments.