Skip to main content

Administration API

API docs by Redocly

StuStaPay Administration API (0.1.0)

Download OpenAPI specification:Download

License: AGPL-3.0

products

List Products

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Product

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
required
Price (number) or Price (null) (Price)
fixed_price
boolean (Fixed Price)
Default: true
Price In Vouchers (integer) or Price In Vouchers (null) (Price In Vouchers)
tax_rate_id
required
integer (Tax Rate Id)
restrictions
Array of strings (Restrictions)
Default: []
Items Enum: "under_16" "under_18"
is_locked
boolean (Is Locked)
Default: false
is_returnable
boolean (Is Returnable)
Default: false
Target Account Id (integer) or Target Account Id (null) (Target Account Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "fixed_price": true,
  • "price_in_vouchers": 0,
  • "tax_rate_id": 0,
  • "restrictions": [ ],
  • "is_locked": false,
  • "is_returnable": false,
  • "target_account_id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "fixed_price": true,
  • "price_in_vouchers": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "is_returnable": true,
  • "target_account_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "type": "discount",
  • "price_per_voucher": 0
}

Get Product

Authorizations:
OAuth2PasswordBearer
path Parameters
product_id
required
integer (Product Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "fixed_price": true,
  • "price_in_vouchers": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "is_returnable": true,
  • "target_account_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "type": "discount",
  • "price_per_voucher": 0
}

Update Product

Authorizations:
OAuth2PasswordBearer
path Parameters
product_id
required
integer (Product Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
required
Price (number) or Price (null) (Price)
fixed_price
boolean (Fixed Price)
Default: true
Price In Vouchers (integer) or Price In Vouchers (null) (Price In Vouchers)
tax_rate_id
required
integer (Tax Rate Id)
restrictions
Array of strings (Restrictions)
Default: []
Items Enum: "under_16" "under_18"
is_locked
boolean (Is Locked)
Default: false
is_returnable
boolean (Is Returnable)
Default: false
Target Account Id (integer) or Target Account Id (null) (Target Account Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "fixed_price": true,
  • "price_in_vouchers": 0,
  • "tax_rate_id": 0,
  • "restrictions": [ ],
  • "is_locked": false,
  • "is_returnable": false,
  • "target_account_id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "fixed_price": true,
  • "price_in_vouchers": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "is_returnable": true,
  • "target_account_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "type": "discount",
  • "price_per_voucher": 0
}

Delete Product

Authorizations:
OAuth2PasswordBearer
path Parameters
product_id
required
integer (Product Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

users

List Users

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Privilege (string) or Filter Privilege (null) (Filter Privilege)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create User

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
login
required
string (Login)
display_name
required
string (Display Name)
Description (string) or Description (null) (Description)
User Tag Pin (string) or User Tag Pin (null) (User Tag Pin)
User Tag Uid Hex (string) or User Tag Uid Hex (null) (User Tag Uid Hex)
Password (string) or Password (null) (Password)

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "description": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid_hex": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid": 0,
  • "description": "string",
  • "node_id": 0,
  • "user_tag_id": 0,
  • "transport_account_id": 0,
  • "cashier_account_id": 0,
  • "id": 0,
  • "user_tag_uid_hex": "string"
}

Get User

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid": 0,
  • "description": "string",
  • "node_id": 0,
  • "user_tag_id": 0,
  • "transport_account_id": 0,
  • "cashier_account_id": 0,
  • "id": 0,
  • "user_tag_uid_hex": "string"
}

Update User

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
login
required
string (Login)
display_name
required
string (Display Name)
Description (string) or Description (null) (Description)
User Tag Pin (string) or User Tag Pin (null) (User Tag Pin)
User Tag Uid Hex (string) or User Tag Uid Hex (null) (User Tag Uid Hex)

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "description": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid_hex": "string"
}

Response samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid": 0,
  • "description": "string",
  • "node_id": 0,
  • "user_tag_id": 0,
  • "transport_account_id": 0,
  • "cashier_account_id": 0,
  • "id": 0,
  • "user_tag_uid_hex": "string"
}

Delete User

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Change User Password

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_password
required
string (New Password)

Responses

Request samples

Content type
application/json
{
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "login": "string",
  • "display_name": "string",
  • "user_tag_pin": "string",
  • "user_tag_uid": 0,
  • "description": "string",
  • "node_id": 0,
  • "user_tag_id": 0,
  • "transport_account_id": 0,
  • "cashier_account_id": 0,
  • "id": 0,
  • "user_tag_uid_hex": "string"
}

user-roles

List User Roles

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create User Role

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
is_privileged
boolean (Is Privileged)
Default: false
privileges
required
Array of strings (Privileges)
Items Enum: "node_administration" "customer_management" "payout_management" "create_user" "allow_privileged_role_assignment" "user_management" "view_node_stats" "cash_transport" "terminal_login" "supervised_terminal_login" "can_book_orders" "grant_free_tickets" "grant_vouchers"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_privileged": false,
  • "privileges": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "is_privileged": false,
  • "privileges": [
    ],
  • "id": 0,
  • "node_id": 0
}

Update User Role

Authorizations:
OAuth2PasswordBearer
path Parameters
user_role_id
required
integer (User Role Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
is_privileged
required
boolean (Is Privileged)
privileges
required
Array of strings (Privileges)
Items Enum: "node_administration" "customer_management" "payout_management" "create_user" "allow_privileged_role_assignment" "user_management" "view_node_stats" "cash_transport" "terminal_login" "supervised_terminal_login" "can_book_orders" "grant_free_tickets" "grant_vouchers"

Responses

Request samples

Content type
application/json
{
  • "is_privileged": true,
  • "privileges": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "is_privileged": false,
  • "privileges": [
    ],
  • "id": 0,
  • "node_id": 0
}

Delete User Role

Authorizations:
OAuth2PasswordBearer
path Parameters
user_role_id
required
integer (User Role Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

user-to-roles

List User To Role

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update User To Roles

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
user_id
required
integer (User Id)
role_ids
required
Array of integers (Role Ids)

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "role_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "role_ids": [
    ],
  • "node_id": 0
}

tax-rates

List Tax Rates

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Tax Rate

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
rate
required
number (Rate)
description
required
string (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "description": "string",
  • "id": 0,
  • "node_id": 0
}

Get Tax Rate

Authorizations:
OAuth2PasswordBearer
path Parameters
tax_rate_id
required
integer (Tax Rate Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "description": "string",
  • "id": 0,
  • "node_id": 0
}

Update Tax Rate

Authorizations:
OAuth2PasswordBearer
path Parameters
tax_rate_id
required
integer (Tax Rate Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
rate
required
number (Rate)
description
required
string (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "description": "string",
  • "id": 0,
  • "node_id": 0
}

Delete Tax Rate

Authorizations:
OAuth2PasswordBearer
path Parameters
tax_rate_id
required
integer (Tax Rate Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

auth

login with username and password

Request Body schema: application/json
required
username
required
string (Username)
password
required
string (Password)
Node Id (integer) or Node Id (null) (Node Id)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "node_id": 0
}

Response samples

Content type
application/json
{
  • "success": {
    },
  • "available_nodes": [
    ]
}

change password

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
old_password
required
string (Old Password)
new_password
required
string (New Password)

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
null

sign out of the current session

Authorizations:
OAuth2PasswordBearer

Responses

tills

List Tills

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Till

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
Active Shift (string) or Active Shift (null) (Active Shift)
active_profile_id
required
integer (Active Profile Id)
Terminal Id (integer) or Terminal Id (null) (Terminal Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active_shift": "string",
  • "active_profile_id": 0,
  • "terminal_id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active_shift": "string",
  • "active_profile_id": 0,
  • "terminal_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "z_nr": 0,
  • "active_user_id": 0,
  • "active_user_role_id": 0,
  • "current_cash_register_name": "string",
  • "current_cash_register_balance": 0,
  • "tse_id": 0,
  • "tse_serial": "string"
}

Get Till

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active_shift": "string",
  • "active_profile_id": 0,
  • "terminal_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "z_nr": 0,
  • "active_user_id": 0,
  • "active_user_role_id": 0,
  • "current_cash_register_name": "string",
  • "current_cash_register_balance": 0,
  • "tse_id": 0,
  • "tse_serial": "string"
}

Update Till

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
Active Shift (string) or Active Shift (null) (Active Shift)
active_profile_id
required
integer (Active Profile Id)
Terminal Id (integer) or Terminal Id (null) (Terminal Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active_shift": "string",
  • "active_profile_id": 0,
  • "terminal_id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active_shift": "string",
  • "active_profile_id": 0,
  • "terminal_id": 0,
  • "node_id": 0,
  • "id": 0,
  • "z_nr": 0,
  • "active_user_id": 0,
  • "active_user_role_id": 0,
  • "current_cash_register_name": "string",
  • "current_cash_register_balance": 0,
  • "tse_id": 0,
  • "tse_serial": "string"
}

Delete Till

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Force Logout User

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Remove From Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Remove From Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Switch Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_terminal_id
required
integer (New Terminal Id)

Responses

Request samples

Content type
application/json
{
  • "new_terminal_id": 0
}

Response samples

Content type
application/json
null

Switch Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_terminal_id
required
integer (New Terminal Id)

Responses

Request samples

Content type
application/json
{
  • "new_terminal_id": 0
}

Response samples

Content type
application/json
null

Switch Till

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_till_id
required
integer (New Till Id)

Responses

Request samples

Content type
application/json
{
  • "new_till_id": 0
}

Response samples

Content type
application/json
null

terminals

Remove From Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Switch Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_terminal_id
required
integer (New Terminal Id)

Responses

Request samples

Content type
application/json
{
  • "new_terminal_id": 0
}

Response samples

Content type
application/json
null

List Terminals

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Terminal

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "node_id": 0,
  • "till_id": 0,
  • "session_uuid": "2997fbdc-9a14-4096-96ce-c929f103e93d",
  • "registration_uuid": "d3efd0ad-ca68-4cd6-922f-541b109aa6f2"
}

Get Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "node_id": 0,
  • "till_id": 0,
  • "session_uuid": "2997fbdc-9a14-4096-96ce-c929f103e93d",
  • "registration_uuid": "d3efd0ad-ca68-4cd6-922f-541b109aa6f2"
}

Update Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": 0,
  • "node_id": 0,
  • "till_id": 0,
  • "session_uuid": "2997fbdc-9a14-4096-96ce-c929f103e93d",
  • "registration_uuid": "d3efd0ad-ca68-4cd6-922f-541b109aa6f2"
}

Delete Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Logout Terminal

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Switch Till

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_till_id
required
integer (New Till Id)

Responses

Request samples

Content type
application/json
{
  • "new_till_id": 0
}

Response samples

Content type
application/json
null

Switch Till

Authorizations:
OAuth2PasswordBearer
path Parameters
terminal_id
required
integer (Terminal Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_till_id
required
integer (New Till Id)

Responses

Request samples

Content type
application/json
{
  • "new_till_id": 0
}

Response samples

Content type
application/json
null

till-layouts

List Till Layouts

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Till Layout

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
description
required
string (Description)
Array of Button Ids (integers) or Button Ids (null) (Button Ids)
Array of Ticket Ids (integers) or Ticket Ids (null) (Ticket Ids)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "button_ids": [
    ],
  • "ticket_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "button_ids": [
    ],
  • "ticket_ids": [
    ]
}

Get Till Layout

Authorizations:
OAuth2PasswordBearer
path Parameters
layout_id
required
integer (Layout Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "button_ids": [
    ],
  • "ticket_ids": [
    ],
  • "node_id": 0,
  • "id": 0
}

Update Till Layout

Authorizations:
OAuth2PasswordBearer
path Parameters
layout_id
required
integer (Layout Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
description
required
string (Description)
Array of Button Ids (integers) or Button Ids (null) (Button Ids)
Array of Ticket Ids (integers) or Ticket Ids (null) (Ticket Ids)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "button_ids": [
    ],
  • "ticket_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "button_ids": [
    ],
  • "ticket_ids": [
    ],
  • "node_id": 0,
  • "id": 0
}

Delete Till Layout

Authorizations:
OAuth2PasswordBearer
path Parameters
layout_id
required
integer (Layout Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

till-profiles

List Till Profiles

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Till Profile

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
layout_id
required
integer (Layout Id)
allow_top_up
required
boolean (Allow Top Up)
allow_cash_out
required
boolean (Allow Cash Out)
allow_ticket_sale
required
boolean (Allow Ticket Sale)
enable_ssp_payment
required
boolean (Enable Ssp Payment)
enable_cash_payment
required
boolean (Enable Cash Payment)
enable_card_payment
required
boolean (Enable Card Payment)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "layout_id": 0,
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "layout_id": 0,
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true
}

Get Till Profile

Authorizations:
OAuth2PasswordBearer
path Parameters
profile_id
required
integer (Profile Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "layout_id": 0,
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true,
  • "node_id": 0,
  • "id": 0
}

Update Till Profile

Authorizations:
OAuth2PasswordBearer
path Parameters
profile_id
required
integer (Profile Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
layout_id
required
integer (Layout Id)
allow_top_up
required
boolean (Allow Top Up)
allow_cash_out
required
boolean (Allow Cash Out)
allow_ticket_sale
required
boolean (Allow Ticket Sale)
enable_ssp_payment
required
boolean (Enable Ssp Payment)
enable_cash_payment
required
boolean (Enable Cash Payment)
enable_card_payment
required
boolean (Enable Card Payment)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "layout_id": 0,
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "layout_id": 0,
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true,
  • "node_id": 0,
  • "id": 0
}

Delete Till Profile

Authorizations:
OAuth2PasswordBearer
path Parameters
profile_id
required
integer (Profile Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

till-buttons

List Till Buttons

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Till Button

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
product_ids
required
Array of integers (Product Ids)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "product_ids": [
    ]
}

Get Till Button

Authorizations:
OAuth2PasswordBearer
path Parameters
button_id
required
integer (Button Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "product_ids": [
    ],
  • "node_id": 0,
  • "id": 0,
  • "price": 0
}

Update Till Button

Authorizations:
OAuth2PasswordBearer
path Parameters
button_id
required
integer (Button Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
product_ids
required
Array of integers (Product Ids)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "product_ids": [
    ],
  • "node_id": 0,
  • "id": 0,
  • "price": 0
}

Delete Till Button

Authorizations:
OAuth2PasswordBearer
path Parameters
button_id
required
integer (Button Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

till-register-stockings

List Register Stockings

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Register Stocking

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
euro200
integer (Euro200)
Default: 0
euro100
integer (Euro100)
Default: 0
euro50
integer (Euro50)
Default: 0
euro20
integer (Euro20)
Default: 0
euro10
integer (Euro10)
Default: 0
euro5
integer (Euro5)
Default: 0
euro2
integer (Euro2)
Default: 0
euro1
integer (Euro1)
Default: 0
cent50
integer (Cent50)
Default: 0
cent20
integer (Cent20)
Default: 0
cent10
integer (Cent10)
Default: 0
cent5
integer (Cent5)
Default: 0
cent2
integer (Cent2)
Default: 0
cent1
integer (Cent1)
Default: 0
variable_in_euro
number (Variable In Euro)
Default: 0

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "euro200": 0,
  • "euro100": 0,
  • "euro50": 0,
  • "euro20": 0,
  • "euro10": 0,
  • "euro5": 0,
  • "euro2": 0,
  • "euro1": 0,
  • "cent50": 0,
  • "cent20": 0,
  • "cent10": 0,
  • "cent5": 0,
  • "cent2": 0,
  • "cent1": 0,
  • "variable_in_euro": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "euro200": 0,
  • "euro100": 0,
  • "euro50": 0,
  • "euro20": 0,
  • "euro10": 0,
  • "euro5": 0,
  • "euro2": 0,
  • "euro1": 0,
  • "cent50": 0,
  • "cent20": 0,
  • "cent10": 0,
  • "cent5": 0,
  • "cent2": 0,
  • "cent1": 0,
  • "variable_in_euro": 0,
  • "node_id": 0,
  • "id": 0,
  • "total": 0
}

Update Register Stocking

Authorizations:
OAuth2PasswordBearer
path Parameters
stocking_id
required
integer (Stocking Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
euro200
integer (Euro200)
Default: 0
euro100
integer (Euro100)
Default: 0
euro50
integer (Euro50)
Default: 0
euro20
integer (Euro20)
Default: 0
euro10
integer (Euro10)
Default: 0
euro5
integer (Euro5)
Default: 0
euro2
integer (Euro2)
Default: 0
euro1
integer (Euro1)
Default: 0
cent50
integer (Cent50)
Default: 0
cent20
integer (Cent20)
Default: 0
cent10
integer (Cent10)
Default: 0
cent5
integer (Cent5)
Default: 0
cent2
integer (Cent2)
Default: 0
cent1
integer (Cent1)
Default: 0
variable_in_euro
number (Variable In Euro)
Default: 0

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "euro200": 0,
  • "euro100": 0,
  • "euro50": 0,
  • "euro20": 0,
  • "euro10": 0,
  • "euro5": 0,
  • "euro2": 0,
  • "euro1": 0,
  • "cent50": 0,
  • "cent20": 0,
  • "cent10": 0,
  • "cent5": 0,
  • "cent2": 0,
  • "cent1": 0,
  • "variable_in_euro": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "euro200": 0,
  • "euro100": 0,
  • "euro50": 0,
  • "euro20": 0,
  • "euro10": 0,
  • "euro5": 0,
  • "euro2": 0,
  • "euro1": 0,
  • "cent50": 0,
  • "cent20": 0,
  • "cent10": 0,
  • "cent5": 0,
  • "cent2": 0,
  • "cent1": 0,
  • "variable_in_euro": 0,
  • "node_id": 0,
  • "id": 0,
  • "total": 0
}

Delete Register Stocking

Authorizations:
OAuth2PasswordBearer
path Parameters
stocking_id
required
integer (Stocking Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

till-registers

List Cash Registers Admin

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Register

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "node_id": 0,
  • "id": 0,
  • "current_cashier_id": 0,
  • "current_till_id": 0,
  • "current_balance": 0
}

Transfer Register

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
source_cashier_id
required
integer (Source Cashier Id)
target_cashier_id
required
integer (Target Cashier Id)

Responses

Request samples

Content type
application/json
{
  • "source_cashier_id": 0,
  • "target_cashier_id": 0
}

Response samples

Content type
application/json
null

Update Register

Authorizations:
OAuth2PasswordBearer
path Parameters
register_id
required
integer (Register Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
null

Delete Register

Authorizations:
OAuth2PasswordBearer
path Parameters
register_id
required
integer (Register Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

config

Get Public Config

Responses

Response samples

Content type
application/json
{
  • "test_mode": true,
  • "test_mode_message": "string",
  • "sumup_topup_enabled_globally": true,
  • "terminal_api_endpoint": "string"
}

List Config Entries

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Set Config Entry

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
key
required
string (Key)
required
Value (string) or Value (null) (Value)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

accounts

List System Accounts

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Find Accounts

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
search_term
required
string (Search Term)

Responses

Request samples

Content type
application/json
{
  • "search_term": "string"
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Get Account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (Account Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "node_id": 0,
  • "id": 0,
  • "type": "private",
  • "name": "string",
  • "comment": "string",
  • "balance": 0,
  • "vouchers": 0,
  • "user_tag_id": 0,
  • "user_tag_uid": 0,
  • "user_tag_comment": "string",
  • "restriction": "under_16",
  • "tag_history": [
    ],
  • "user_tag_uid_hex": "string"
}

Disable Account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (Account Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Update Balance

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (Account Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_balance
required
number (New Balance)

Responses

Request samples

Content type
application/json
{
  • "new_balance": 0
}

Response samples

Content type
application/json
null

Update Voucher Amount

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (Account Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
new_voucher_amount
required
integer (New Voucher Amount)

Responses

Request samples

Content type
application/json
{
  • "new_voucher_amount": 0
}

Response samples

Content type
application/json
null

Update Account Comment

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (Account Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
comment
required
string (Comment)

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "node_id": 0,
  • "id": 0,
  • "type": "private",
  • "name": "string",
  • "comment": "string",
  • "balance": 0,
  • "vouchers": 0,
  • "user_tag_id": 0,
  • "user_tag_uid": 0,
  • "user_tag_comment": "string",
  • "restriction": "under_16",
  • "tag_history": [
    ],
  • "user_tag_uid_hex": "string"
}

Find Customers

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
search_term
required
string (Search Term)

Responses

Request samples

Content type
application/json
{
  • "search_term": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Customer

Authorizations:
OAuth2PasswordBearer
path Parameters
customer_id
required
integer (Customer Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "node_id": 0,
  • "id": 0,
  • "type": "private",
  • "name": "string",
  • "comment": "string",
  • "balance": 0,
  • "vouchers": 0,
  • "user_tag_id": 0,
  • "user_tag_uid": 0,
  • "user_tag_comment": "string",
  • "restriction": "under_16",
  • "tag_history": [
    ],
  • "iban": "string",
  • "account_name": "string",
  • "email": "string",
  • "donation": 0,
  • "payout_export": true,
  • "user_tag_pin": "string",
  • "donate_all": true,
  • "has_entered_info": true,
  • "payout": {
    },
  • "user_tag_uid_hex": "string"
}

Prevent Customer Payout

Authorizations:
OAuth2PasswordBearer
path Parameters
customer_id
required
integer (Customer Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Allow Customer Payout

Authorizations:
OAuth2PasswordBearer
path Parameters
customer_id
required
integer (Customer Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

orders

List Orders By Till

Authorizations:
OAuth2PasswordBearer
path Parameters
till_id
required
integer (Till Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

List Orders

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Customer Account Id (integer) or Customer Account Id (null) (Customer Account Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Get Order

Authorizations:
OAuth2PasswordBearer
path Parameters
order_id
required
integer (Order Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "total_price": 0,
  • "total_tax": 0,
  • "total_no_tax": 0,
  • "cancels_order": 0,
  • "booked_at": "2019-08-24T14:15:22Z",
  • "payment_method": "cash",
  • "order_type": "sale",
  • "cashier_id": 0,
  • "till_id": 0,
  • "customer_account_id": 0,
  • "customer_tag_uid": 0,
  • "customer_tag_id": 0,
  • "line_items": [
    ],
  • "customer_tag_uid_hex": "string"
}

Cancel Order

Authorizations:
OAuth2PasswordBearer
path Parameters
order_id
required
integer (Order Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Edit Order

Authorizations:
OAuth2PasswordBearer
path Parameters
order_id
required
integer (Order Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
uuid
required
string <uuid> (Uuid)
Used Vouchers (integer) or Used Vouchers (null) (Used Vouchers)
required
Array of objects (Products)

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "used_vouchers": 0,
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "old_balance": 0,
  • "new_balance": 0,
  • "old_voucher_balance": 0,
  • "new_voucher_balance": 0,
  • "customer_account_id": 0,
  • "payment_method": "cash",
  • "line_items": [
    ],
  • "products": [
    ],
  • "id": 0,
  • "booked_at": "2019-08-24T14:15:22Z",
  • "cashier_id": 0,
  • "till_id": 0,
  • "used_vouchers": 0,
  • "item_count": 0,
  • "total_price": 0
}

cashiers

List Cashiers

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Get Cashier

Authorizations:
OAuth2PasswordBearer
path Parameters
cashier_id
required
integer (Cashier Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "node_id": 0,
  • "id": 0,
  • "login": "string",
  • "display_name": "string",
  • "description": "string",
  • "user_tag_id": 0,
  • "user_tag_uid": 0,
  • "transport_account_id": 0,
  • "cashier_account_id": 0,
  • "cash_register_id": 0,
  • "cash_drawer_balance": 0,
  • "till_ids": [
    ],
  • "user_tag_uid_hex": "string"
}

Get Cashier Shifts

Authorizations:
OAuth2PasswordBearer
path Parameters
cashier_id
required
integer (Cashier Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Get Cashier Shift Stats

Authorizations:
OAuth2PasswordBearer
path Parameters
cashier_id
required
integer (Cashier Id)
query Parameters
node_id
required
integer (Node Id)
Shift Id (integer) or Shift Id (null) (Shift Id)

Responses

Response samples

Content type
application/json
{
  • "booked_products": [
    ],
  • "orders": [
    ]
}

Close Out Cashier

Authorizations:
OAuth2PasswordBearer
path Parameters
cashier_id
required
integer (Cashier Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
comment
required
string (Comment)
actual_cash_drawer_balance
required
number (Actual Cash Drawer Balance)
closing_out_user_id
required
integer (Closing Out User Id)

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "actual_cash_drawer_balance": 0,
  • "closing_out_user_id": 0
}

Response samples

Content type
application/json
{
  • "cashier_id": 0,
  • "imbalance": 0
}

stats

Get Product Stats

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
To Timestamp (string) or To Timestamp (null) (To Timestamp)
From Timestamp (string) or From Timestamp (null) (From Timestamp)

Responses

Response samples

Content type
application/json
{
  • "from_time": "2019-08-24T14:15:22Z",
  • "to_time": "2019-08-24T14:15:22Z",
  • "daily_intervals": [
    ],
  • "hourly_intervals": [
    ],
  • "product_hourly_intervals": [
    ],
  • "product_overall_stats": [
    ],
  • "deposit_hourly_intervals": [
    ],
  • "deposit_overall_stats": [
    ]
}

Get Voucher Stats

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
To Timestamp (string) or To Timestamp (null) (To Timestamp)
From Timestamp (string) or From Timestamp (null) (From Timestamp)

Responses

Response samples

Content type
application/json
{
  • "vouchers_issued": 0,
  • "vouchers_spent": 0
}

Get Entry Stats

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
To Timestamp (string) or To Timestamp (null) (To Timestamp)
From Timestamp (string) or From Timestamp (null) (From Timestamp)

Responses

Response samples

Content type
application/json
{
  • "from_time": "2019-08-24T14:15:22Z",
  • "to_time": "2019-08-24T14:15:22Z",
  • "daily_intervals": [
    ],
  • "hourly_intervals": [
    ]
}

Get Top Up Stats

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
To Timestamp (string) or To Timestamp (null) (To Timestamp)
From Timestamp (string) or From Timestamp (null) (From Timestamp)

Responses

Response samples

Content type
application/json
{
  • "from_time": "2019-08-24T14:15:22Z",
  • "to_time": "2019-08-24T14:15:22Z",
  • "daily_intervals": [
    ],
  • "hourly_intervals": [
    ]
}

Get Pay Out Stats

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
To Timestamp (string) or To Timestamp (null) (To Timestamp)
From Timestamp (string) or From Timestamp (null) (From Timestamp)

Responses

Response samples

Content type
application/json
{
  • "from_time": "2019-08-24T14:15:22Z",
  • "to_time": "2019-08-24T14:15:22Z",
  • "daily_intervals": [
    ],
  • "hourly_intervals": [
    ]
}

tickets

List Tickets

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Ticket

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
price
required
number (Price)
tax_rate_id
required
integer (Tax Rate Id)
restrictions
required
Array of strings (Restrictions)
Items Enum: "under_16" "under_18"
is_locked
required
boolean (Is Locked)
initial_top_up_amount
required
number (Initial Top Up Amount)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "initial_top_up_amount": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "initial_top_up_amount": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "total_price": 0
}

Get Ticket

Authorizations:
OAuth2PasswordBearer
path Parameters
ticket_id
required
integer (Ticket Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "initial_top_up_amount": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "total_price": 0
}

Update Ticket

Authorizations:
OAuth2PasswordBearer
path Parameters
ticket_id
required
integer (Ticket Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
price
required
number (Price)
tax_rate_id
required
integer (Tax Rate Id)
restrictions
required
Array of strings (Restrictions)
Items Enum: "under_16" "under_18"
is_locked
required
boolean (Is Locked)
initial_top_up_amount
required
number (Initial Top Up Amount)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "initial_top_up_amount": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "tax_rate_id": 0,
  • "restrictions": [
    ],
  • "is_locked": true,
  • "initial_top_up_amount": 0,
  • "node_id": 0,
  • "id": 0,
  • "tax_name": "string",
  • "tax_rate": 0,
  • "total_price": 0
}

Delete Ticket

Authorizations:
OAuth2PasswordBearer
path Parameters
ticket_id
required
integer (Ticket Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

user_tags

Create User Tag Secret

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
key0
required
string (Key0)
key1
required
string (Key1)
description
required
string (Description)

Responses

Request samples

Content type
application/json
{
  • "key0": "string",
  • "key1": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "key0": "string",
  • "key1": "string",
  • "description": "string",
  • "id": 0,
  • "node_id": 0
}

List User Tag Secrets

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create User Tags

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
Array
pin
required
string (Pin)
ProductRestriction (string) or null
secret_id
required
integer (Secret Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Find User Tags

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
search_term
required
string (Search Term)

Responses

Request samples

Content type
application/json
{
  • "search_term": "string"
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Get User Tag Detail

Authorizations:
OAuth2PasswordBearer
path Parameters
user_tag_id
required
integer (User Tag Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pin": "string",
  • "uid": 0,
  • "node_id": 0,
  • "comment": "string",
  • "account_id": 0,
  • "user_id": 0,
  • "account_history": [
    ],
  • "uid_hex": "string"
}

Update User Tag Comment

Authorizations:
OAuth2PasswordBearer
path Parameters
user_tag_id
required
integer (User Tag Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
comment
required
string (Comment)

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "pin": "string",
  • "uid": 0,
  • "node_id": 0,
  • "comment": "string",
  • "account_id": 0,
  • "user_id": 0,
  • "account_history": [
    ],
  • "uid_hex": "string"
}

tses

List Tses

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Tse

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
ws_url
required
string (Ws Url)
ws_timeout
required
number (Ws Timeout)
password
required
string (Password)
type
required
string (TseType)
Value: "diebold_nixdorf"
Value: "diebold_nixdorf"
required
Serial (string) or Serial (null) (Serial)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ws_url": "string",
  • "ws_timeout": 0,
  • "password": "string",
  • "type": "diebold_nixdorf",
  • "serial": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ws_url": "string",
  • "ws_timeout": 0,
  • "password": "string",
  • "type": "diebold_nixdorf",
  • "serial": "string",
  • "node_id": 0,
  • "id": 0,
  • "status": "new",
  • "hashalgo": "string",
  • "time_format": "string",
  • "public_key": "string",
  • "certificate": "string",
  • "process_data_encoding": "string"
}

Update Tse

Authorizations:
OAuth2PasswordBearer
path Parameters
tse_id
required
integer (Tse Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
ws_url
required
string (Ws Url)
ws_timeout
required
number (Ws Timeout)
password
required
string (Password)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ws_url": "string",
  • "ws_timeout": 0,
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "ws_url": "string",
  • "ws_timeout": 0,
  • "password": "string",
  • "type": "diebold_nixdorf",
  • "serial": "string",
  • "node_id": 0,
  • "id": 0,
  • "status": "new",
  • "hashalgo": "string",
  • "time_format": "string",
  • "public_key": "string",
  • "certificate": "string",
  • "process_data_encoding": "string"
}

payouts

List Payout Runs

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "entities": {
    }
}

Create Payout Run

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
max_payout_sum
required
number (Max Payout Sum)
max_num_payouts
required
integer (Max Num Payouts)

Responses

Request samples

Content type
application/json
{
  • "max_payout_sum": 0,
  • "max_num_payouts": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "node_id": 0,
  • "created_by": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "set_done_by": 0,
  • "set_done_at": "2019-08-24T14:15:22Z",
  • "done": true,
  • "revoked": true,
  • "sepa_was_generated": true,
  • "total_donation_amount": 0,
  • "total_payout_amount": 0,
  • "n_payouts": 0
}

Pending Payout Detail

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "total_payout_amount": 0,
  • "total_donation_amount": 0,
  • "n_payouts": 0
}

Payout Run Payouts

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payout Run Csv Export

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
"string"

Payout Run Sepa Xml

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
execution_date
required
string <date> (Execution Date)

Responses

Request samples

Content type
application/json
{
  • "execution_date": "2019-08-24"
}

Response samples

Content type
application/json
"string"

Previous Payout Run Sepa Xml

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
"string"

Set Payout Run As Done

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Revoke Payout Run

Authorizations:
OAuth2PasswordBearer
path Parameters
payout_run_id
required
integer (Payout Run Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

tree

Get Tree For Current User

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent": 0,
  • "name": "string",
  • "description": "string",
  • "read_only": true,
  • "event": {
    },
  • "path": "string",
  • "parent_ids": [
    ],
  • "event_node_id": 0,
  • "parents_until_event_node": [
    ],
  • "forbidden_objects_at_node": [
    ],
  • "computed_forbidden_objects_at_node": [
    ],
  • "forbidden_objects_in_subtree": [
    ],
  • "computed_forbidden_objects_in_subtree": [
    ],
  • "children": [
    ],
  • "privileges_at_node": [
    ]
}

Create Node

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
description
required
string (Description)
forbidden_objects_at_node
Array of strings (Forbidden Objects At Node)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"
forbidden_objects_in_subtree
Array of strings (Forbidden Objects In Subtree)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "forbidden_objects_at_node": [ ],
  • "forbidden_objects_in_subtree": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent": 0,
  • "name": "string",
  • "description": "string",
  • "read_only": true,
  • "event": {
    },
  • "path": "string",
  • "parent_ids": [
    ],
  • "event_node_id": 0,
  • "parents_until_event_node": [
    ],
  • "forbidden_objects_at_node": [
    ],
  • "computed_forbidden_objects_at_node": [
    ],
  • "forbidden_objects_in_subtree": [
    ],
  • "computed_forbidden_objects_in_subtree": [
    ],
  • "children": [
    ]
}

Update Node

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
name
required
string (Name)
description
required
string (Description)
forbidden_objects_at_node
Array of strings (Forbidden Objects At Node)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"
forbidden_objects_in_subtree
Array of strings (Forbidden Objects In Subtree)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "forbidden_objects_at_node": [ ],
  • "forbidden_objects_in_subtree": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent": 0,
  • "name": "string",
  • "description": "string",
  • "read_only": true,
  • "event": {
    },
  • "path": "string",
  • "parent_ids": [
    ],
  • "event_node_id": 0,
  • "parents_until_event_node": [
    ],
  • "forbidden_objects_at_node": [
    ],
  • "computed_forbidden_objects_at_node": [
    ],
  • "forbidden_objects_in_subtree": [
    ],
  • "computed_forbidden_objects_in_subtree": [
    ],
  • "children": [
    ]
}

Archive Node

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Create Event

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
sumup_api_key
string (Sumup Api Key)
Default: ""
sumup_affiliate_key
string (Sumup Affiliate Key)
Default: ""
sumup_merchant_code
string (Sumup Merchant Code)
Default: ""
sumup_oauth_client_id
string (Sumup Oauth Client Id)
Default: ""
sumup_oauth_client_secret
string (Sumup Oauth Client Secret)
Default: ""
Email Smtp Password (string) or Email Smtp Password (null) (Email Smtp Password)
currency_identifier
required
string (Currency Identifier)
max_account_balance
required
number (Max Account Balance)
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Daily End Time (string) or Daily End Time (null) (Daily End Time)
sumup_topup_enabled
required
boolean (Sumup Topup Enabled)
sumup_payment_enabled
required
boolean (Sumup Payment Enabled)
customer_portal_url
required
string (Customer Portal Url)
customer_portal_about_page_url
required
string (Customer Portal About Page Url)
customer_portal_data_privacy_url
required
string (Customer Portal Data Privacy Url)
customer_portal_contact_email
required
string <email> (Customer Portal Contact Email)
ust_id
required
string (Ust Id)
bon_issuer
required
string (Bon Issuer)
bon_address
required
string (Bon Address)
bon_title
required
string (Bon Title)
sepa_enabled
required
boolean (Sepa Enabled)
sepa_sender_name
required
string (Sepa Sender Name)
sepa_sender_iban
required
string (Sepa Sender Iban)
sepa_description
required
string (Sepa Description)
Sepa Max Num Payouts In Run (integer) or Sepa Max Num Payouts In Run (null) (Sepa Max Num Payouts In Run)
sepa_allowed_country_codes
required
Array of strings (Sepa Allowed Country Codes)
email_enabled
required
boolean (Email Enabled)
Email Default Sender (string) or Email Default Sender (null) (Email Default Sender)
Email Smtp Host (string) or Email Smtp Host (null) (Email Smtp Host)
Email Smtp Port (integer) or Email Smtp Port (null) (Email Smtp Port)
Email Smtp Username (string) or Email Smtp Username (null) (Email Smtp Username)
payout_done_subject
required
string (Payout Done Subject)
payout_done_message
required
string (Payout Done Message)
payout_registered_subject
required
string (Payout Registered Subject)
payout_registered_message
required
string (Payout Registered Message)
Payout Sender (string) or Payout Sender (null) (Payout Sender)
object (Translation Texts)
Default: {}
name
required
string (Name)
description
required
string (Description)
forbidden_objects_at_node
Array of strings (Forbidden Objects At Node)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"
forbidden_objects_in_subtree
Array of strings (Forbidden Objects In Subtree)
Default: []
Items Enum: "user" "product" "ticket" "till" "user_role" "tax_rate" "user_tag" "tse" "account" "terminal"

Responses

Request samples

Content type
application/json
{
  • "sumup_api_key": "",
  • "sumup_affiliate_key": "",
  • "sumup_merchant_code": "",
  • "sumup_oauth_client_id": "",
  • "sumup_oauth_client_secret": "",
  • "email_smtp_password": "string",
  • "currency_identifier": "string",
  • "max_account_balance": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "daily_end_time": "14:15:22Z",
  • "sumup_topup_enabled": true,
  • "sumup_payment_enabled": true,
  • "customer_portal_url": "string",
  • "customer_portal_about_page_url": "string",
  • "customer_portal_data_privacy_url": "string",
  • "customer_portal_contact_email": "user@example.com",
  • "ust_id": "string",
  • "bon_issuer": "string",
  • "bon_address": "string",
  • "bon_title": "string",
  • "sepa_enabled": true,
  • "sepa_sender_name": "string",
  • "sepa_sender_iban": "string",
  • "sepa_description": "string",
  • "sepa_max_num_payouts_in_run": 0,
  • "sepa_allowed_country_codes": [
    ],
  • "email_enabled": true,
  • "email_default_sender": "string",
  • "email_smtp_host": "string",
  • "email_smtp_port": 0,
  • "email_smtp_username": "string",
  • "payout_done_subject": "string",
  • "payout_done_message": "string",
  • "payout_registered_subject": "string",
  • "payout_registered_message": "string",
  • "payout_sender": "string",
  • "translation_texts": { },
  • "name": "string",
  • "description": "string",
  • "forbidden_objects_at_node": [ ],
  • "forbidden_objects_in_subtree": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent": 0,
  • "name": "string",
  • "description": "string",
  • "read_only": true,
  • "event": {
    },
  • "path": "string",
  • "parent_ids": [
    ],
  • "event_node_id": 0,
  • "parents_until_event_node": [
    ],
  • "forbidden_objects_at_node": [
    ],
  • "computed_forbidden_objects_at_node": [
    ],
  • "forbidden_objects_in_subtree": [
    ],
  • "computed_forbidden_objects_in_subtree": [
    ],
  • "children": [
    ]
}

Update Event

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
sumup_api_key
string (Sumup Api Key)
Default: ""
sumup_affiliate_key
string (Sumup Affiliate Key)
Default: ""
sumup_merchant_code
string (Sumup Merchant Code)
Default: ""
sumup_oauth_client_id
string (Sumup Oauth Client Id)
Default: ""
sumup_oauth_client_secret
string (Sumup Oauth Client Secret)
Default: ""
Email Smtp Password (string) or Email Smtp Password (null) (Email Smtp Password)
currency_identifier
required
string (Currency Identifier)
max_account_balance
required
number (Max Account Balance)
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Daily End Time (string) or Daily End Time (null) (Daily End Time)
sumup_topup_enabled
required
boolean (Sumup Topup Enabled)
sumup_payment_enabled
required
boolean (Sumup Payment Enabled)
customer_portal_url
required
string (Customer Portal Url)
customer_portal_about_page_url
required
string (Customer Portal About Page Url)
customer_portal_data_privacy_url
required
string (Customer Portal Data Privacy Url)
customer_portal_contact_email
required
string <email> (Customer Portal Contact Email)
ust_id
required
string (Ust Id)
bon_issuer
required
string (Bon Issuer)
bon_address
required
string (Bon Address)
bon_title
required
string (Bon Title)
sepa_enabled
required
boolean (Sepa Enabled)
sepa_sender_name
required
string (Sepa Sender Name)
sepa_sender_iban
required
string (Sepa Sender Iban)
sepa_description
required
string (Sepa Description)
Sepa Max Num Payouts In Run (integer) or Sepa Max Num Payouts In Run (null) (Sepa Max Num Payouts In Run)
sepa_allowed_country_codes
required
Array of strings (Sepa Allowed Country Codes)
email_enabled
required
boolean (Email Enabled)
Email Default Sender (string) or Email Default Sender (null) (Email Default Sender)
Email Smtp Host (string) or Email Smtp Host (null) (Email Smtp Host)
Email Smtp Port (integer) or Email Smtp Port (null) (Email Smtp Port)
Email Smtp Username (string) or Email Smtp Username (null) (Email Smtp Username)
payout_done_subject
required
string (Payout Done Subject)
payout_done_message
required
string (Payout Done Message)
payout_registered_subject
required
string (Payout Registered Subject)
payout_registered_message
required
string (Payout Registered Message)
Payout Sender (string) or Payout Sender (null) (Payout Sender)
object (Translation Texts)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "sumup_api_key": "",
  • "sumup_affiliate_key": "",
  • "sumup_merchant_code": "",
  • "sumup_oauth_client_id": "",
  • "sumup_oauth_client_secret": "",
  • "email_smtp_password": "string",
  • "currency_identifier": "string",
  • "max_account_balance": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "daily_end_time": "14:15:22Z",
  • "sumup_topup_enabled": true,
  • "sumup_payment_enabled": true,
  • "customer_portal_url": "string",
  • "customer_portal_about_page_url": "string",
  • "customer_portal_data_privacy_url": "string",
  • "customer_portal_contact_email": "user@example.com",
  • "ust_id": "string",
  • "bon_issuer": "string",
  • "bon_address": "string",
  • "bon_title": "string",
  • "sepa_enabled": true,
  • "sepa_sender_name": "string",
  • "sepa_sender_iban": "string",
  • "sepa_description": "string",
  • "sepa_max_num_payouts_in_run": 0,
  • "sepa_allowed_country_codes": [
    ],
  • "email_enabled": true,
  • "email_default_sender": "string",
  • "email_smtp_host": "string",
  • "email_smtp_port": 0,
  • "email_smtp_username": "string",
  • "payout_done_subject": "string",
  • "payout_done_message": "string",
  • "payout_registered_subject": "string",
  • "payout_registered_message": "string",
  • "payout_sender": "string",
  • "translation_texts": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent": 0,
  • "name": "string",
  • "description": "string",
  • "read_only": true,
  • "event": {
    },
  • "path": "string",
  • "parent_ids": [
    ],
  • "event_node_id": 0,
  • "parents_until_event_node": [
    ],
  • "forbidden_objects_at_node": [
    ],
  • "computed_forbidden_objects_at_node": [
    ],
  • "forbidden_objects_in_subtree": [
    ],
  • "computed_forbidden_objects_in_subtree": [
    ],
  • "children": [
    ]
}

Get Restricted Event Settings

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "sumup_api_key": "",
  • "sumup_affiliate_key": "",
  • "sumup_merchant_code": "",
  • "sumup_oauth_client_id": "",
  • "sumup_oauth_client_secret": "",
  • "email_smtp_password": "string",
  • "currency_identifier": "string",
  • "max_account_balance": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "daily_end_time": "14:15:22Z",
  • "sumup_topup_enabled": true,
  • "sumup_payment_enabled": true,
  • "customer_portal_url": "string",
  • "customer_portal_about_page_url": "string",
  • "customer_portal_data_privacy_url": "string",
  • "customer_portal_contact_email": "user@example.com",
  • "ust_id": "string",
  • "bon_issuer": "string",
  • "bon_address": "string",
  • "bon_title": "string",
  • "sepa_enabled": true,
  • "sepa_sender_name": "string",
  • "sepa_sender_iban": "string",
  • "sepa_description": "string",
  • "sepa_max_num_payouts_in_run": 0,
  • "sepa_allowed_country_codes": [
    ],
  • "email_enabled": true,
  • "email_default_sender": "string",
  • "email_smtp_host": "string",
  • "email_smtp_port": 0,
  • "email_smtp_username": "string",
  • "payout_done_subject": "string",
  • "payout_done_message": "string",
  • "payout_registered_subject": "string",
  • "payout_registered_message": "string",
  • "payout_sender": "string",
  • "translation_texts": { },
  • "id": 0,
  • "languages": [
    ],
  • "sumup_oauth_refresh_token": "string"
}

Delete Node

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
null

Generate Test Bon

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "order": {
    },
  • "tax_rate_aggregations": [
    ],
  • "config": {
    },
  • "currency_identifier": "string"
}

Generate Test Report

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
null

Generate Revenue Report

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
null

Configure Sumup Token

Authorizations:
OAuth2PasswordBearer
path Parameters
node_id
required
integer (Node Id)
Request Body schema: application/json
required
authorization_code
required
string (Authorization Code)

Responses

Request samples

Content type
application/json
{
  • "authorization_code": "string"
}

Response samples

Content type
application/json
null

sumup

List Sumup Checkouts

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Sumup Transactions

Authorizations:
OAuth2PasswordBearer
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Sumup Checkout

Authorizations:
OAuth2PasswordBearer
path Parameters
checkout_id
required
string (Checkout Id)
query Parameters
node_id
required
integer (Node Id)

Responses

Response samples

Content type
application/json
{
  • "checkout_reference": "b3a6ed62-ac25-4221-886c-eec2a90d7771",
  • "amount": 0,
  • "currency": "string",
  • "merchant_code": "string",
  • "description": "string",
  • "id": "string",
  • "status": "PENDING",
  • "valid_until": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "transaction_code": "string",
  • "transaction_id": "string",
  • "transactions": [ ]
}