Add stage only terminal file build by terminal alias

API Method: POST /api/v1/merchant/stageOnlyTerminal

Description:

This API endpoint is used to create a pre-filled stage-only terminal for a merchant. The created terminal can be used to generate a VAR sheet (which contains important terminal configuration details) or to be activated and used later in the production environment. This allows merchants to pre-configure terminals for future use, ensuring all necessary details are in place before the terminal goes live.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/merchant/stageOnlyTerminal
• Content-Type: application/json

Request Body Parameters:

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

• merchantProfileId (required):
  The unique identifier for the merchant profile. This ID is used to associate the pre-filled terminal with the correct merchant account.
  • Type: int32
  • Example: "merchantProfileId": 12345

Response:

• Status Code:

  • 201 Created: If the pre-filled stage-only terminal is successfully created.
  • 400 Bad Request: If the merchantProfileId is missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  A confirmation message or details of the newly created pre-filled terminal, which can be used for VAR sheet generation or future activation.

Example Request:

POST /api/v1/merchant/stageOnlyTerminal
Content-Type: application/json

{
  "merchantProfileId": 12345
}

Use Case:

This API method is ideal for merchants who want to pre-configure a terminal for future use or generate a VAR sheet for terminal setup. The terminal is created in a staging environment, allowing for testing, review, and readiness before it is fully deployed in production. This ensures smooth operations when the terminal is needed later.