Terminalserver API

• base
  • gethealth check endpoint
  • getobtain the current terminal config
  • getobtain the list of available cash register stockings
  • getlist all cash registers
  • poststock up a cash register
  • postObtain information about a user tag
• order
  • getlist all orders
  • postcheck if a sale is valid
  • postfinish the sale and book the transactions
  • postcheck if a top up is valid
  • postfinish the top up and book the transactions
  • postcheck if a ticket sale is valid
  • postcheck if a ticket sale is valid
  • postfinish a ticket sale and book the transactions
  • postcheck if a pay out is valid
  • postfinish the pay out and book the transactions
  • postcancel information about an order
  • getget information about an order
• auth
  • postRegister a new Terminal
  • postLog out this Terminal
• user
  • getGet the currently logged in User
  • postCheck if a user can login to the terminal and return his roles
  • postLogin User
  • postLogout the current user
  • postCreate a new user with the given roles
  • postUpdate the roles of a given user
  • postgrant a free ticket, e.g. to a volunteer
  • postgrant vouchers to a customer
• customer
  • postSwitch Tag
  • getObtain a customer by tag uid
  • getObtain all orders of a customer by tag uid
• cashier
  • postupdate the balance of a cash register by transferring money from / to a orga transport account
  • postupdate the balance of a transport account by transferring money from / to the cash vault
  • posttransfer a cash register between two cashiers
• mgmt
  • postGet revenue statistics for the current node

API docs by Redocly

StuStaPay Terminal API (0.1.0)

Download OpenAPI specification:Download

License: AGPL-3.0

base

health check endpoint

Responses

https://stustapay.de/health

Response samples

• 200

Content type

application/json

null

obtain the current terminal config

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/config

Response samples

• 200

Content type

application/json

{

• "id": 0,
• "name": "string",
• "description": "string",
• "till": {

  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "event_name": "string",
  • "profile_name": "string",
  • "user_privileges": [

    • "node_administration"

    ],
  • "cash_register_id": 0,
  • "cash_register_name": "string",
  • "allow_top_up": true,
  • "allow_cash_out": true,
  • "allow_ticket_sale": true,
  • "enable_ssp_payment": true,
  • "enable_cash_payment": true,
  • "enable_card_payment": true,
  • "buttons": [

    • {

      • "id": 0,
      • "name": "string",
      • "price": 0,
      • "default_price": 0,
      • "price_in_vouchers": 0,
      • "price_per_voucher": 0,
      • "is_returnable": true,
      • "fixed_price": true

      }

    ],
  • "secrets": {

    • "sumup_affiliate_key": "string",
    • "sumup_api_key": "string",
    • "sumup_api_key_expires_at": "2019-08-24T14:15:22Z",
    • "user_tag_secret": {

      • "key0": "string",
      • "key1": "string"

      }

    },
  • "active_user_id": 0,
  • "available_roles": [

    • {

      • "name": "string",
      • "is_privileged": false,
      • "privileges": [

        • "node_administration"

        ],
      • "id": 0,
      • "node_id": 0

      }

    ]

  },
• "test_mode": true,
• "test_mode_message": "string"

}

obtain the list of available cash register stockings

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/cash-register-stockings

Response samples

• 200

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

  }

]

list all cash registers

Authorizations:

OAuth2PasswordBearer

query Parameters

hide_assigned

boolean (Hide Assigned) Default: true

Responses

https://stustapay.de/cash-registers

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "name": "string",
  • "node_id": 0,
  • "id": 0,
  • "current_cashier_id": 0,
  • "current_till_id": 0,
  • "current_balance": 0

  }

]

stock up a cash register

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

cashier_tag_uid required	integer (Cashier Tag Uid)
cash_register_id required	integer (Cash Register Id)
register_stocking_id required	integer (Register Stocking Id)

Responses

https://stustapay.de/stock-up-cash-register

Request samples

• Payload

Content type

application/json

{

• "cashier_tag_uid": 0,
• "cash_register_id": 0,
• "register_stocking_id": 0

}

Response samples

• 200
• 422

Content type

application/json

null

Obtain information about a user tag

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

user_tag_uid required

integer (User Tag Uid)

Responses

https://stustapay.de/user-info

Request samples

• Payload

Content type

application/json

{

• "user_tag_uid": 0

}

Response samples

• 200
• 422

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,
• "cash_register_id": 0,
• "cash_register_name": "string",
• "cash_drawer_balance": 0,
• "transport_account_balance": 0,
• "assigned_roles": [

  • {

    • "id": 0,
    • "name": "string",
    • "is_privileged": true,
    • "privileges": [

      • "node_administration"

      ],
    • "node_id": 0,
    • "node_name": "string",
    • "is_at_current_node": true

    }

  ],
• "user_tag_uid_hex": "string"

}

order

list all orders

List all the order of the currently logged in Cashier

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/order

Response samples

• 200

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": [

    • {

      • "quantity": 0,
      • "product": {

        • "name": "string",
        • "price": 0,
        • "fixed_price": true,
        • "price_in_vouchers": 0,
        • "tax_rate_id": 0,
        • "restrictions": [

          • "under_16"

          ],
        • "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

        },
      • "product_price": 0,
      • "tax_rate_id": 0,
      • "tax_name": "string",
      • "tax_rate": 0,
      • "item_id": 0,
      • "total_tax": 0,
      • "total_price": 0

      }

    ],
  • "customer_tag_uid_hex": "string"

  }

]

check if a sale is valid

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
	Customer Tag Uid (integer) or Customer Tag Uid (null) (Customer Tag Uid)
payment_method required	string (PaymentMethod) Enum: "cash" "sumup" "tag" "sumup_online"
	Used Vouchers (integer) or Used Vouchers (null) (Used Vouchers)
required	Array of objects (Buttons)

Responses

https://stustapay.de/order/check-sale

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "payment_method": "cash",
• "used_vouchers": 0,
• "buttons": [

  • {

    • "till_button_id": 0,
    • "quantity": 0,
    • "price": 0

    }

  ]

}

Response samples

• 200
• 422

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": [

  • {

    • "quantity": 0,
    • "product": {

      • "name": "string",
      • "price": 0,
      • "fixed_price": true,
      • "price_in_vouchers": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "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

      },
    • "product_price": 0,
    • "tax_rate_id": 0,
    • "tax_name": "string",
    • "tax_rate": 0,
    • "total_price": 0

    }

  ],
• "buttons": [

  • {

    • "till_button_id": 0,
    • "quantity": 0,
    • "price": 0

    }

  ],
• "used_vouchers": 0,
• "item_count": 0,
• "total_price": 0

}

finish the sale and book the transactions

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
	Customer Tag Uid (integer) or Customer Tag Uid (null) (Customer Tag Uid)
payment_method required	string (PaymentMethod) Enum: "cash" "sumup" "tag" "sumup_online"
	Used Vouchers (integer) or Used Vouchers (null) (Used Vouchers)
required	Array of objects (Buttons)

Responses

https://stustapay.de/order/book-sale

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "payment_method": "cash",
• "used_vouchers": 0,
• "buttons": [

  • {

    • "till_button_id": 0,
    • "quantity": 0,
    • "price": 0

    }

  ]

}

Response samples

• 200
• 422

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": [

  • {

    • "quantity": 0,
    • "product": {

      • "name": "string",
      • "price": 0,
      • "fixed_price": true,
      • "price_in_vouchers": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "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

      },
    • "product_price": 0,
    • "tax_rate_id": 0,
    • "tax_name": "string",
    • "tax_rate": 0,
    • "total_price": 0

    }

  ],
• "buttons": [

  • {

    • "till_button_id": 0,
    • "quantity": 0,
    • "price": 0

    }

  ],
• "id": 0,
• "booked_at": "2019-08-24T14:15:22Z",
• "cashier_id": 0,
• "till_id": 0,
• "bon_url": "string",
• "used_vouchers": 0,
• "item_count": 0,
• "total_price": 0

}

check if a top up is valid

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
payment_method required	string (PaymentMethod) Enum: "cash" "sumup" "tag" "sumup_online"
amount required	number (Amount)
customer_tag_uid required	integer (Customer Tag Uid)

Responses

https://stustapay.de/order/check-topup

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "payment_method": "cash",
• "amount": 0,
• "customer_tag_uid": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "payment_method": "cash",
• "amount": 0,
• "customer_tag_uid": 0,
• "customer_account_id": 0,
• "old_balance": 0,
• "new_balance": 0

}

finish the top up and book the transactions

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
payment_method required	string (PaymentMethod) Enum: "cash" "sumup" "tag" "sumup_online"
amount required	number (Amount)
customer_tag_uid required	integer (Customer Tag Uid)

Responses

https://stustapay.de/order/book-topup

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "payment_method": "cash",
• "amount": 0,
• "customer_tag_uid": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "payment_method": "cash",
• "customer_tag_uid": 0,
• "customer_account_id": 0,
• "amount": 0,
• "old_balance": 0,
• "new_balance": 0,
• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "booked_at": "2019-08-24T14:15:22Z",
• "cashier_id": 0,
• "till_id": 0

}

check if a ticket sale is valid

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

required	Array of objects (Customer Tags)
Array tag_uid required integer (Tag Uid) tag_pin required string (Tag Pin)

Responses

https://stustapay.de/order/check-ticket-scan

Request samples

• Payload

Content type

application/json

{

• "customer_tags": [

  • {

    • "tag_uid": 0,
    • "tag_pin": "string"

    }

  ]

}

Response samples

• 200
• 422

Content type

application/json

{

• "scanned_tickets": [

  • {

    • "customer_tag_uid": 0,
    • "customer_tag_pin": "string",
    • "ticket": {

      • "name": "string",
      • "price": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "is_locked": true,
      • "initial_top_up_amount": 0,
      • "node_id": 0,
      • "id": 0,
      • "tax_name": "string",
      • "tax_rate": 0,
      • "total_price": 0

      }

    }

  ]

}

check if a ticket sale is valid

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
required	Array of objects (Customer Tags)
required	PaymentMethod (string) or null

Responses

https://stustapay.de/order/check-ticket-sale

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tags": [

  • {

    • "tag_uid": 0,
    • "tag_pin": "string"

    }

  ],
• "payment_method": "cash"

}

Response samples

• 200
• 422

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "payment_method": "cash",
• "line_items": [

  • {

    • "quantity": 0,
    • "product": {

      • "name": "string",
      • "price": 0,
      • "fixed_price": true,
      • "price_in_vouchers": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "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

      },
    • "product_price": 0,
    • "tax_rate_id": 0,
    • "tax_name": "string",
    • "tax_rate": 0,
    • "total_price": 0

    }

  ],
• "scanned_tickets": [

  • {

    • "customer_tag_uid": 0,
    • "customer_tag_pin": "string",
    • "ticket": {

      • "name": "string",
      • "price": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "is_locked": true,
      • "initial_top_up_amount": 0,
      • "node_id": 0,
      • "id": 0,
      • "tax_name": "string",
      • "tax_rate": 0,
      • "total_price": 0

      }

    }

  ],
• "item_count": 0,
• "total_price": 0

}

finish a ticket sale and book the transactions

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
required	Array of objects (Customer Tags)
required	PaymentMethod (string) or null

Responses

https://stustapay.de/order/book-ticket-sale

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tags": [

  • {

    • "tag_uid": 0,
    • "tag_pin": "string"

    }

  ],
• "payment_method": "cash"

}

Response samples

• 200
• 422

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "payment_method": "cash",
• "line_items": [

  • {

    • "quantity": 0,
    • "product": {

      • "name": "string",
      • "price": 0,
      • "fixed_price": true,
      • "price_in_vouchers": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "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

      },
    • "product_price": 0,
    • "tax_rate_id": 0,
    • "tax_name": "string",
    • "tax_rate": 0,
    • "total_price": 0

    }

  ],
• "scanned_tickets": [

  • {

    • "customer_tag_uid": 0,
    • "customer_tag_pin": "string",
    • "ticket": {

      • "name": "string",
      • "price": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "is_locked": true,
      • "initial_top_up_amount": 0,
      • "node_id": 0,
      • "id": 0,
      • "tax_name": "string",
      • "tax_rate": 0,
      • "total_price": 0

      }

    }

  ],
• "id": 0,
• "booked_at": "2019-08-24T14:15:22Z",
• "customer_account_id": 0,
• "cashier_id": 0,
• "till_id": 0,
• "item_count": 0,
• "total_price": 0

}

check if a pay out is valid

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
customer_tag_uid required	integer (Customer Tag Uid)
	Amount (number) or Amount (null) (Amount)

Responses

https://stustapay.de/order/check-payout

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "amount": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "amount": 0,
• "customer_account_id": 0,
• "old_balance": 0,
• "new_balance": 0

}

finish the pay out and book the transactions

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uuid required	string <uuid> (Uuid)
customer_tag_uid required	integer (Customer Tag Uid)
	Amount (number) or Amount (null) (Amount)

Responses

https://stustapay.de/order/book-payout

Request samples

• Payload

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "amount": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
• "customer_tag_uid": 0,
• "amount": 0,
• "customer_account_id": 0,
• "old_balance": 0,
• "new_balance": 0,
• "booked_at": "2019-08-24T14:15:22Z",
• "cashier_id": 0,
• "till_id": 0

}

cancel information about an order

Authorizations:

OAuth2PasswordBearer

path Parameters

order_id required

integer (Order Id)

Responses

https://stustapay.de/order/{order_id}/cancel

Response samples

• 200
• 422

Content type

application/json

null

get information about an order

Authorizations:

OAuth2PasswordBearer

path Parameters

order_id required

integer (Order Id)

Responses

https://stustapay.de/order/{order_id}

Response samples

• 200
• 422

Content type

application/json

Example

OrderResponse Show Order Order Id GetOrder

{

• "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": [

  • {

    • "quantity": 0,
    • "product": {

      • "name": "string",
      • "price": 0,
      • "fixed_price": true,
      • "price_in_vouchers": 0,
      • "tax_rate_id": 0,
      • "restrictions": [

        • "under_16"

        ],
      • "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

      },
    • "product_price": 0,
    • "tax_rate_id": 0,
    • "tax_name": "string",
    • "tax_rate": 0,
    • "item_id": 0,
    • "total_tax": 0,
    • "total_price": 0

    }

  ],
• "customer_tag_uid_hex": "string"

}

auth

Register a new Terminal

Request Body schema: application/json

required

registration_uuid required

string (Registration Uuid)

Responses

https://stustapay.de/auth/register_terminal

Request samples

• Payload

Content type

application/json

{

• "registration_uuid": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "terminal": {

  • "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"

  },
• "token": "string"

}

Log out this Terminal

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/auth/logout_terminal

user

Get the currently logged in User

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/user

Response samples

• 200

Content type

application/json

Example

CurrentUserResponse Get Current User User GetCurrentUser

{

• "node_id": 0,
• "id": 0,
• "login": "string",
• "display_name": "string",
• "active_role_id": 0,
• "active_role_name": "string",
• "privileges": [

  • "node_administration"

  ],
• "description": "string",
• "user_tag_id": 0,
• "user_tag_uid": 0,
• "transport_account_id": 0,
• "cashier_account_id": 0,
• "cash_register_id": 0

}

Check if a user can login to the terminal and return his roles

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

uid required

integer (Uid)

Responses

https://stustapay.de/user/check-login

Request samples

• Payload

Content type

application/json

{

• "uid": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "user_tag": {

  • "uid": 0

  },
• "roles": [

  • {

    • "name": "string",
    • "is_privileged": false,
    • "privileges": [

      • "node_administration"

      ],
    • "id": 0,
    • "node_id": 0

    }

  ]

}

Login User

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

required	object (UserTag)
user_role_id required	integer (User Role Id)

Responses

https://stustapay.de/user/login

Request samples

• Payload

Content type

application/json

{

• "user_tag": {

  • "uid": 0

  },
• "user_role_id": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "node_id": 0,
• "id": 0,
• "login": "string",
• "display_name": "string",
• "active_role_id": 0,
• "active_role_name": "string",
• "privileges": [

  • "node_administration"

  ],
• "description": "string",
• "user_tag_id": 0,
• "user_tag_uid": 0,
• "transport_account_id": 0,
• "cashier_account_id": 0,
• "cash_register_id": 0

}

Logout the current user

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/user/logout

Create a new user with the given roles

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

login required	string (Login)
display_name required	string (Display Name)
	User Tag Pin (string) or User Tag Pin (null) (User Tag Pin)
	User Tag Uid (integer) or User Tag Uid (null) (User Tag Uid)
	Description (string) or Description (null) (Description)
role_ids required	Array of integers (Role Ids)

Responses

https://stustapay.de/user/create-user

Request samples

• Payload

Content type

application/json

{

• "login": "string",
• "display_name": "string",
• "user_tag_pin": "string",
• "user_tag_uid": 0,
• "description": "string",
• "role_ids": [

  • 0

  ]

}

Response samples

• 200
• 422

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 the roles of a given user

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

user_tag_uid required	integer (User Tag Uid)
role_ids required	Array of integers (Role Ids)

Responses

https://stustapay.de/user/update-user-roles

Request samples

• Payload

Content type

application/json

{

• "user_tag_uid": 0,
• "role_ids": [

  • 0

  ]

}

Response samples

• 200
• 422

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"

}

grant a free ticket, e.g. to a volunteer

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

user_tag_pin required	string (User Tag Pin)
user_tag_uid required	integer (User Tag Uid)
initial_voucher_amount	integer (Initial Voucher Amount) Default: 0

Responses

https://stustapay.de/user/grant-free-ticket

Request samples

• Payload

Content type

application/json

{

• "user_tag_pin": "string",
• "user_tag_uid": 0,
• "initial_voucher_amount": 0

}

Response samples

• 200
• 422

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_id": 0,
    • "user_tag_pin": "string",
    • "user_tag_uid": 0,
    • "account_id": 0,
    • "comment": "string",
    • "mapping_was_valid_until": "2019-08-24T14:15:22Z",
    • "user_tag_uid_hex": "string"

    }

  ],
• "user_tag_uid_hex": "string"

}

grant vouchers to a customer

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

vouchers required	integer (Vouchers)
user_tag_uid required	integer (User Tag Uid)

Responses

https://stustapay.de/user/grant-vouchers

Request samples

• Payload

Content type

application/json

{

• "vouchers": 0,
• "user_tag_uid": 0

}

Response samples

• 200
• 422

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_id": 0,
    • "user_tag_pin": "string",
    • "user_tag_uid": 0,
    • "account_id": 0,
    • "comment": "string",
    • "mapping_was_valid_until": "2019-08-24T14:15:22Z",
    • "user_tag_uid_hex": "string"

    }

  ],
• "user_tag_uid_hex": "string"

}

customer

Switch Tag

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

old_user_tag_pin required	string (Old User Tag Pin)
new_user_tag_uid required	integer (New User Tag Uid)
new_user_tag_pin required	string (New User Tag Pin)
comment required	string (Comment)

Responses

https://stustapay.de/customer/switch_tag

Request samples

• Payload

Content type

application/json

{

• "old_user_tag_pin": "string",
• "new_user_tag_uid": 0,
• "new_user_tag_pin": "string",
• "comment": "string"

}

Response samples

• 200
• 422

Content type

application/json

null

Obtain a customer by tag uid

Authorizations:

OAuth2PasswordBearer

path Parameters

customer_tag_uid required

integer (Customer Tag Uid)

Responses

https://stustapay.de/customer/{customer_tag_uid}

Response samples

• 200
• 422

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_id": 0,
    • "user_tag_pin": "string",
    • "user_tag_uid": 0,
    • "account_id": 0,
    • "comment": "string",
    • "mapping_was_valid_until": "2019-08-24T14:15:22Z",
    • "user_tag_uid_hex": "string"

    }

  ],
• "user_tag_uid_hex": "string"

}

Obtain all orders of a customer by tag uid

Authorizations:

OAuth2PasswordBearer

path Parameters

customer_tag_uid required

integer (Customer Tag Uid)

Responses

https://stustapay.de/customer/{customer_tag_uid}/orders

Response samples

• 200
• 422

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": [

    • {

      • "quantity": 0,
      • "product": {

        • "name": "string",
        • "price": 0,
        • "fixed_price": true,
        • "price_in_vouchers": 0,
        • "tax_rate_id": 0,
        • "restrictions": [

          • "under_16"

          ],
        • "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

        },
      • "product_price": 0,
      • "tax_rate_id": 0,
      • "tax_name": "string",
      • "tax_rate": 0,
      • "item_id": 0,
      • "total_tax": 0,
      • "total_price": 0

      }

    ],
  • "customer_tag_uid_hex": "string"

  }

]

cashier

update the balance of a cash register by transferring money from / to a orga transport account

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

cashier_tag_uid required	integer (Cashier Tag Uid)
amount required	number (Amount)

Responses

https://stustapay.de/change-cash-register-balance

Request samples

• Payload

Content type

application/json

{

• "cashier_tag_uid": 0,
• "amount": 0

}

Response samples

• 200
• 422

Content type

application/json

null

update the balance of a transport account by transferring money from / to the cash vault

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

orga_tag_uid required	integer (Orga Tag Uid)
amount required	number (Amount)

Responses

https://stustapay.de/change-transport-register-balance

Request samples

• Payload

Content type

application/json

{

• "orga_tag_uid": 0,
• "amount": 0

}

Response samples

• 200
• 422

Content type

application/json

null

transfer a cash register between two cashiers

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

source_cashier_tag_uid required	integer (Source Cashier Tag Uid)
target_cashier_tag_uid required	integer (Target Cashier Tag Uid)

Responses

https://stustapay.de/transfer-cash-register

Request samples

• Payload

Content type

application/json

{

• "source_cashier_tag_uid": 0,
• "target_cashier_tag_uid": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "name": "string",
• "node_id": 0,
• "id": 0,
• "current_cashier_id": 0,
• "current_till_id": 0,
• "current_balance": 0

}

mgmt

Get revenue statistics for the current node

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

required	From Time (string) or From Time (null) (From Time)
required	To Time (string) or To Time (null) (To Time)

Responses

https://stustapay.de/mgmtrevenue-stats

Request samples

• Payload

Content type

application/json

{

• "from_time": "2019-08-24T14:15:22Z",
• "to_time": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 422

Content type

application/json

{

• "from_time": "2019-08-24T14:15:22Z",
• "to_time": "2019-08-24T14:15:22Z",
• "daily_intervals": [

  • {

    • "from_time": "2019-08-24T14:15:22Z",
    • "to_time": "2019-08-24T14:15:22Z",
    • "count": 0,
    • "revenue": 0

    }

  ],
• "hourly_intervals": [

  • {

    • "from_time": "2019-08-24T14:15:22Z",
    • "to_time": "2019-08-24T14:15:22Z",
    • "count": 0,
    • "revenue": 0

    }

  ]

}