Merchant Boarding API Specification

Merchant Boarding API

Application Equipment

Application Equipment Management

Get Equipment Details

get /application/equipment/key/{externalKey}

Retrieve application equipment details by application external key.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

00000000-00000000-0000000000-00000000-000000000000

Example Response

200 Successfully retrieved application equipment details.

401 Unauthorized API Response.

404 Application not found.

500 Internal server error.

Update Equipment Details

put /application/equipment/key/{externalKey}

Update application equipment details by application external key.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

00000000-00000000-0000000000-00000000-000000000000

Request Schema

equipmentGroup required

Type

array

semiIntegratedSettingParameters required

Type

object

Example Request

{
  "equipmentGroup": [
    {
      "equipmentGroupId": 1,
      "quantity": 1,
      "semiIntegrationEnabled": false,
      "terminal": {
        "equipmentId": 1296,
        "equipmentName": "DESK3500",
        "freePlacement": "merchant",
        "gatewayAccountId": null,
        "orderType": "deploy",
        "serialNumber": null,
        "terminalSettingParameters": {
          "autoCloseTime": "21:00",
          "batchCloseType": "auto",
          "customReceiptFooter": null,
          "downloadComments": null,
          "giftCardProvider": "Valutec",
          "includeServerId": false,
          "isDebitEnabled": true,
          "isEbtEnabled": false,
          "isEdgeProgramEnabled": false,
          "isTipLineOnReceiptEnabled": false,
          "isTipPromptOnTerminalEnabled": false,
          "otherSoftwareDetails": null,
          "reportOptions": "totals",
          "softwareType": "retail",
          "terminalAccessKey": null
        },
        "epxSettings": {
          "terminalId": "999123",
          "dbaId": "1234567829",
          "isAvsOnlyTerminal": true
        }
      },
      "pinpad": null,
      "printer": null,
      "checkReader": null,
      "other": []
    }
  ],
  "semiIntegratedSettingParameters": {
    "semiIntegratedSoftwareGatewayId": null,
    "semiIntegratedSoftwareId": null
  }
}

Example Response

200 Successfully updated application equipment details.

400 Validation error.

401 Unauthorized API Response.

404 Application not found.

500 Internal server error.