Register Terminal

Registers a card-present payment terminal on your account so you can charge checkouts on it.

Send the device's hardware ID and type as printed on the device or given by your payment processor. The terminal is
created in PENDING_VALIDATION and checked with your processor in the background; it then becomes ACTIVE, or
INVALID when the processor does not recognise it. Read it with Get Terminal to follow the result. Only an ACTIVE,
connected terminal can be used as terminalId in Charge Checkout.

Permission: Merchant Write.

Errors

  • 400 VALIDATION_ERROR: friendlyName, hardwareId or hardwareType is missing, hardwareType is not a supported
    value, or the body has an unknown field.
  • 409 TERMINAL_ALREADY_EXISTS: a terminal with this hardwareId is already registered.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The fields accepted by Register Terminal. Any other field is rejected.

string
required

Name your staff see when they pick the terminal, for example Front desk 1.

string
required

The device's hardware identifier, such as its serial number, as given by your payment processor.

string
enum
required

The device model family. Ask Payment Labs which value matches your devices.

Allowed:
string

Optional free-text note, for example where the device is located.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json