Create a new terminal

POST 
/terminals

Create a new terminal

Request

Header Parameters

sub-account stringrequired

Sub-account identifier required for all requests

application/json

Body

required

account_id stringrequired

Unique identifier for the account.

favorite_contract_type string

Possible values: [RIBPAY, VADS]

Type of contract to be shown first. Can be null

label string

Label/name of the terminal. Will default to "New Terminal" if not provided.

subscription_type string

Possible values: [ribpay_classic, ribpay_plus]

Type of subscription for the terminal.

creator_id uuidrequired

Unique identifier for the creator of the terminal.

Responses

201

Terminal created successfully

application/json

Schema

Schema

terminal_id uuidrequired

Unique identifier for the terminal.

terminal_label stringrequired

Label/name of the terminal.

terminal_favorite_contract_type stringrequired

Type of contract to be shown first.

terminal_subscription_type stringrequired

Type of subscription for the terminal.

terminal_last_modified stringrequired

Date the terminal was modified.

account_id uuidrequired

Unique identifier for the account.

terminal_subscription_id uuidrequired

Unique identifier for the subscription.

creator_id uuidrequired

Unique identifier for the creator.

Example (from schema)

{
  "terminal_id": "f45b68fa-4586-4453-83af-ee2c1c2ecc27",
  "terminal_label": "New Terminal",
  "terminal_favorite_contract_type": "RIBPAY",
  "terminal_subscription_type": "payments",
  "terminal_last_modified": "2021-09-30T17:00:00.000Z",
  "account_id": "b9f8e467-90a2-4976-9cd5-1624bdd80ab4",
  "terminal_subscription_id": "b9f8e467-90a2-4976-9cd5-1624bdd80ab4",
  "creator_id": "b9f8e467-90a2-4976-9cd5-1624bdd80ab4"
}

Loading...