Add terminal file build by terminal alias

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

Description:

This API endpoint allows the addition of a new terminal file for a merchant's payment processing system. The terminal file is built using the terminal’s alias, which acts as a unique identifier for the terminal configuration. This file contains necessary data to configure and operate the terminal within the merchant’s system.

Request:

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

Request Body Parameters:

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

  • alias (required):
    A unique identifier or alias for the terminal configuration. This alias helps identify the terminal within the merchant’s system.

    • Type: string
    • Example: "alias": "POS_Terminal_001"
  • fileData (optional):
    The data or content of the terminal file being added. This might include configuration details, firmware information, or any necessary operational settings for the terminal.

    • Type: string
    • Example: "fileData": "Base64-encoded content"

Response:

  • Status Code:

    • 201 Created: If the terminal file is successfully added.
    • 400 Bad Request: If required fields are missing or invalid.
    • 500 Internal Server Error: If there is an issue processing the request.
  • Response Body:
    The response includes the details of the newly added terminal, including the terminal ID and confirmation that the file has been successfully created.

Use Case:

This API method is used by ISO/ISV or administrators to add a new terminal to the merchant’s payment processing system. By providing the terminal alias and any necessary file data, this endpoint helps configure and register a new terminal for operational use, ensuring it is properly set up within the merchant's platform.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!