Create the terminal of the Charge Anywhere

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

Description:

This API endpoint is used to create a new terminal for the Charge Anywhere payment processing service. A terminal can be either a physical or virtual device used by the merchant for payment transactions. The request includes necessary details such as the merchant's profile, device type, and optional configurations like SIM details for wireless terminals. The endpoint allows the creation of both virtual and physical terminals for a specific merchant.

Request:

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

Request Body Parameters:

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

• merchantProfileId (required):
  A unique identifier for the merchant profile.

  • Type: int32
  • Example: "merchantProfileId": 12345

• deviceTypeId (required):
  A string identifier for the type of device to be created (e.g., virtual or physical terminal).

  • Type: string
  • Example: "deviceTypeId": "virtual"

• terminalId (optional):
  A unique identifier for the terminal being created. This can be auto-generated if not provided.

  • Type: int32
  • Example: "terminalId": 67890

• serialNumber (optional):
  The serial number of the terminal device, used mainly for physical terminals.

  • Type: string
  • Example: "serialNumber": "SN123456789"

• wireless (optional):
  A boolean flag indicating whether the terminal is wireless.

  • Type: boolean
  • Example: "wireless": true

• simType (optional):
  The type of SIM card used by the wireless terminal (if applicable).

  • Type: string
  • Example: "simType": "4G"

• simNumber (optional):
  The SIM card number for wireless terminals.

  • Type: string
  • Example: "simNumber": "SIM987654321"

Response:

• Status Code:

  • 201 Created: If the terminal is successfully created.
  • 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 contains the details of the newly created terminal, including the terminal ID and status.

Example Request:

POST /api/v1/merchant/chargeAnywhere/terminal
Content-Type: application/json

{
  "merchantProfileId": 12345,
  "deviceTypeId": "virtual",
  "terminalId": 67890,
  "serialNumber": "SN123456789",
  "wireless": true,
  "simType": "4G",
  "simNumber": "SIM987654321"
}

Use Case:

This API method is used by ISO/ISV or administrators to create a new terminal for the Charge Anywhere payment processing service. The terminal could be a virtual terminal for online use or a physical terminal for in-person payments. The additional options for wireless terminals (SIM type and number) help configure mobile or portable terminals.