Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Point of Sale - Device Directory API

Tribe Payments Point of Sale Device Directory API (v3) for registering, managing, and querying the estate of physical and SoftPOS payment terminals (devices) connected to Tribe's acquiring platform. Harvested verbatim from the Tribe developer portal.

Point of Sale - Device Directory API is one of 15 APIs that Tribe Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Point of Sale, Terminals, Device Management, and United Kingdom. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 23 operations across 14 paths, organized into 3 resource areas, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

23 operations 14 paths 13 schemas 3 DELETE12 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Resource Areas
3

Paths & Operations 23

Across 14 paths, the API surfaces 23 operations — 3 DELETE, 12 GET, 5 POST, 3 PUT. They span 3 resource areas: Processor, App, Host. Each is listed below with its method, path, parameters, and response codes.

Processor 8
GET
/processors/{processorId}/hosts
Get a list of hosts assigned to processor
7 params → 200400
POST
/processors/{processorId}/hosts
Create a host.
2 params body → 201400
GET
/processors/{processorId}/hosts/{hostId}
Get a host
2 params → 200400
PUT
/processors/{processorId}/hosts/{hostId}
Update a host.
3 params body → 200400
DELETE
/processors/{processorId}/hosts/{hostId}
Delete a host
3 params → 204404
GET
/processors/{processorId}/devices
Get a list of devices assigned to processor
7 params → 200400
GET
/processors/{processorId}/devices/{deviceId}
Get a device
2 params → 200400404
GET
/processors/{processorId}/terminals/{terminalId}
Get a device
2 params → 200400404
App 4
GET
/apps/{appId}/hosts/{hostId}
Get a host
2 params → 200400
GET
/apps/{appId}/terminals/{terminalId}
Get a terminal
2 params → 200404
GET
/apps/{appId}/devices/{deviceId}
Get a device
2 params → 200400
POST
/apps/{appId}/terminals/{terminalId}/activate
Activate a terminal.
3 params body → 200400422
Host 11
GET
/hosts/{hostId}/devices
Get a list of devices assigned to host
7 params → 200400
POST
/hosts/{hostId}/devices
Create a device
3 params body → 201422
GET
/hosts/{hostId}/devices/{deviceId}
Get a device
2 params → 200404
PUT
/hosts/{hostId}/devices/{deviceId}
Update a device
3 params body → 200400404422
DELETE
/hosts/{hostId}/devices/{deviceId}
Delete a device
3 params → 204404
GET
/hosts/{hostId}/terminals
Get terminals
5 params → 200400
POST
/hosts/{hostId}/terminals
Create a terminal
2 params body → 201400422
GET
/hosts/{hostId}/terminals/{terminalId}
Get a terminal
2 params → 200404
PUT
/hosts/{hostId}/terminals/{terminalId}
Update a terminal
3 params body → 200400404422
DELETE
/hosts/{hostId}/terminals/{terminalId}
Delete a terminal
3 params → 204400404
POST
/hosts/{hostId}/terminals/{terminalId}/regenerate-activation-code
Regenarate activation code for a terminal
3 params → 200400

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Terminal (7 properties), Device (7 properties), TerminalAppResponse (6 properties), TerminalActivatedResponse (6 properties). Each schema is shown below with its type and property counts.

TerminalActivateRequest
object
1 property 1 required
Device
object
7 properties
UpdateDeviceRequest
object
3 properties
CreateDeviceRequest
object
3 properties 3 required
CreateTerminalRequest
object
2 properties 1 required
ValidationProblemDetails
object
3 properties
Terminal
object
7 properties
TerminalAppResponse
object
6 properties
TerminalActivatedResponse
object
6 properties
Host
object
5 properties
HostCreate
object
2 properties
Violation
object
3 properties
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tribe-payments-trb-isac-pos-tdd-device-api-openapi-device-directory-api-v3.json Raw ↑

Other APIs Tribe Payments publishes across the network.

Payment Gateway - Credit Card API
Payment Gateway - Hosted Payments API (HPP)
Payment Gateway - Credit Card Token API
Payment Gateway - Reports API
Risk Monitor - Client API
Open Banking - Bank API
Open Banking - Third-Party Providers API (TPP)
Issuer Processor - Program Manager API (PM API)
Issuer Processor - Transaction Authorization Interface (TAI API)
Acquiring Processor - Acquirer API (ACAPI)
Acquiring Processor - Merchant API (MAPI)
Acquiring Processor - Terminal API (TAPI)