Add Non-POS equipment to the merchant application

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

Description:

This API endpoint is used to add Non-POS equipment (such as accessories, peripherals, or other non-terminal devices) to a merchant's application. Merchants or administrators can provide details about the equipment being added, including the quantity, payment type, and other relevant information. This endpoint helps manage non-POS equipment for a merchant's payment processing system.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/equipment/regular
• 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 Non-POS equipment is being added.

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

• purchaseId (optional):
  The identifier for the purchase associated with the equipment, linking the equipment to a specific purchase transaction.

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

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

  • Type: int32
  • Example: "equipmentId": 445566"

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

  • Type: int32
  • Example: "quantity": 3

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

  • Type: double
  • Example: "purchasePrice": 199.99

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

  • Type: double
  • Example: "monthlyPayment": 15.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 equipment.

  • Type: string
  • Example: "note": "Spare cash drawer for POS system"

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

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

Response:

• Status Code:

  • 201 Created: If the Non-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 Non-POS equipment.

Example Request:

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

{
  "id": 12345,
  "purchaseId": 67890,
  "equipmentId": 445566,
  "quantity": 3,
  "purchasePrice": 199.99,
  "monthlyPayment": 15.99,
  "paymentType": "purchase",
  "note": "Spare cash drawer for POS system",
  "fundersIds": 1002
}

Use Case:

This API method is used by ISO/ISV or administrators to add and manage Non-POS equipment (such as cash drawers, printers, or other accessories) within the merchant's payment processing system. It allows merchants to track the quantity, purchase details, and payment methods for Non-POS equipment, ensuring complete inventory management for their setup.