Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Merchant Devices

Retrieve Merchant Devices

Retrieves a paginated list of merchant devices for a merchant.

get/merchant-devices

Query parameters

externalTerminalIDstring
Example:12345678

The unique id for the terminal assigned to the merchant.

limitinteger

The number of items to return

offsetinteger

The number of items to skip before returning the results

Headers

Content-Type'application/json' | 'application/json;charset=UTF-8' required

Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.

FSV-Interaction-Idstring required
Example:9591e6d8-0d70-11ea-8d71-362b9e155667

An RFC4122 UUID used as to trace requests.

Environmentstring required

For test environment, specific test environment name should be passed (e.g. "bwu15"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value "prod" should be populated.

Institution-Numberstring required
Example:00000099

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

Internal-Merchant-Idstring required

OPY Internal Client Number

Response

OK

Example response

{
  "meta": {
    "paging": {
      "count": 100,
      "totalPages": 10,
      "currentOffset": 1,
      "currentNumberOfRetrievedRecords": 10,
      "maxLimit": 10,
      "hasMoreRecords": true,
      "pageNumber": 1
    },
    "sorting": {
      "sort": "name,-startDate"
    },
    "messages": [
      {
        "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
        "code": "ACCOUNT_NUMBER_NOT_FOUND",
        "title": "The authorization credentials required for this request are invalid.",
        "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
        "source": {
          "pointer": "/dogs/name",
          "parameter": "type",
          "header": "type"
        }
      }
    ]
  },
  "data": [
    {
      "externalTerminalId": "54999530",
      "serialNumber": "123456789",
      "contactName": "John Doe",
      "terminalLocation": "Munich",
      "terminalCountry": {
        "countryCode": "IRE"
      },
      "city": "Valletta",
      "telephone": "003531123456",
      "schemaId": "000000",
      "accountCurrencyCode": "EUR",
      "systemBatchId": "234234",
      "serviceProvider": {
        "serviceProviderIndex": "001"
      },
      "acquiringProfile": {
        "acquiringProfileIndex": "000"
      },
      "templateId": "C234",
      "clientFee": {
        "clientFeeIndex": "402"
      },
      "feeEffectiveDate": "20200615",
      "feeExpiryDate": "20200615",
      "lastFeeDate": "20200615",
      "configOfTerminal": {
        "configOfTerminalIndex": "001"
      },
      "terminalType": {
        "terminalTypeIndex": "000"
      },
      "emv": true,
      "installDate": "20200615",
      "activeDate": "20200615",
      "terminationDate": "20200615",
      "terminalPassword": "password",
      "workStation": "Terminal WONO",
      "amexDetails": {
        "amexPhoneNo1": "00012458754865148",
        "amexPhoneNo2": "00012458754865148",
        "relatedTId": "FreeText"
      },
      "scheduleOfChargeDetails": {
        "socCode": "00054214",
        "waiver": "waiver02",
        "setupFee": "3232000",
        "gprsRental": "Monthly",
        "gprsRentalAmount": "325",
        "installed": "Installed"
      },
      "lastUpdatedBy": "John Smith",
      "lastUpdatedDate": "20210406"
    }
  ],
  "errors": [
    {
      "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
      "code": "ACCOUNT_NUMBER_NOT_FOUND",
      "title": "The authorization credentials required for this request are invalid.",
      "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
      "source": {
        "pointer": "/dogs/name",
        "parameter": "type",
        "header": "type"
      }
    }
  ],
  "links": {
    "self": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=3&limit=10",
    "first": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=1&limit=10",
    "last": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=10&limit=10",
    "prev": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=2&limit=10",
    "next": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=4&limit=10"
  }
}