Customer Portal API

• auth
  • postcustomer login with wristband hardware tag and pin
  • postsign out of the current session
• base
  • getObtain customer
  • getObtain customer orders
  • postset iban, account name and email
  • postshortcut to declare that customer wants to donate all of the remaining balance
  • getinfo about current state of payout
  • gettransactions booked for payout if payout already happened
  • getget customer customer portal config
  • getRetrieve a bon
• sumup
  • postinitiate customer checkout
  • postafter payment check checkout state

API docs by Redocly

StuStaPay Customer Portal API (0.1.0)

Download OpenAPI specification:Download

License: AGPL-3.0

auth

customer login with wristband hardware tag and pin

Request Body schema: application/json

required

pin required

string (Pin)

Responses

https://stustapay.de/auth/login

Request samples

• Payload

Content type

application/json

{

• "pin": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "customer": {

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

      }

    ],
  • "iban": "string",
  • "account_name": "string",
  • "email": "string",
  • "donation": 0,
  • "payout_export": true,
  • "user_tag_pin": "string",
  • "donate_all": true,
  • "has_entered_info": true,
  • "payout": {

    • "id": 0,
    • "customer_account_id": 0,
    • "iban": "string",
    • "account_name": "string",
    • "email": "string",
    • "user_tag_id": 0,
    • "user_tag_uid": 0,
    • "amount": 0,
    • "donation": 0,
    • "payout_run_id": 0,
    • "user_tag_uid_hex": "string"

    },
  • "user_tag_uid_hex": "string"

  },
• "access_token": "string",
• "grant_type": "bearer"

}

sign out of the current session

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/auth/logout

base

Obtain customer

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/customer

Response samples

• 200

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"

    }

  ],
• "iban": "string",
• "account_name": "string",
• "email": "string",
• "donation": 0,
• "payout_export": true,
• "user_tag_pin": "string",
• "donate_all": true,
• "has_entered_info": true,
• "payout": {

  • "id": 0,
  • "customer_account_id": 0,
  • "iban": "string",
  • "account_name": "string",
  • "email": "string",
  • "user_tag_id": 0,
  • "user_tag_uid": 0,
  • "amount": 0,
  • "donation": 0,
  • "payout_run_id": 0,
  • "user_tag_uid_hex": "string"

  },
• "user_tag_uid_hex": "string"

}

Obtain customer orders

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/orders_with_bon

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

      }

    ],
  • "bon_generated": true,
  • "customer_tag_uid_hex": "string"

  }

]

set iban, account name and email

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

iban required	string (Iban)
account_name required	string (Account Name)
email required	string (Email)
donation	number (Donation) Default: 0

Responses

https://stustapay.de/customer_info

Request samples

• Payload

Content type

application/json

{

• "iban": "string",
• "account_name": "string",
• "email": "string",
• "donation": 0

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

shortcut to declare that customer wants to donate all of the remaining balance

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/customer_all_donation

info about current state of payout

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/payout_info

Response samples

• 200

Content type

application/json

{

• "in_payout_run": true,
• "payout_date": "2019-08-24T14:15:22Z"

}

transactions booked for payout if payout already happened

Authorizations:

OAuth2PasswordBearer

Responses

https://stustapay.de/get_payout_transactions

Response samples

• 200

Content type

application/json

[

• {

  • "amount": 0,
  • "booked_at": "2019-08-24T14:15:22Z",
  • "target_account_name": "string",
  • "target_account_type": "string",
  • "transaction_id": 0

  }

]

get customer customer portal config

query Parameters

base_url required

string (Base Url)

Responses

https://stustapay.de/config

Response samples

• 200
• 422

Content type

application/json

{

• "test_mode": true,
• "test_mode_message": "string",
• "data_privacy_url": "string",
• "contact_email": "user@example.com",
• "about_page_url": "string",
• "payout_enabled": true,
• "currency_identifier": "string",
• "sumup_topup_enabled": true,
• "allowed_country_codes": [

  • "string"

  ],
• "translation_texts": {

  • "property1": {

    • "property1": "string",
    • "property2": "string"

    },
  • "property2": {

    • "property1": "string",
    • "property2": "string"

    }

  }

}

Retrieve a bon

path Parameters

order_uuid required

string (Order Uuid)

Responses

https://stustapay.de/bon/{order_uuid}

Response samples

• 200
• 422

Content type

application/json

{

• "order": {

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

      }

    ],
  • "signature_status": "string",
  • "transaction_process_type": "string",
  • "transaction_process_data": "string",
  • "tse_transaction": "string",
  • "tse_signaturenr": "string",
  • "tse_start": "string",
  • "tse_end": "string",
  • "tse_hashalgo": "string",
  • "tse_time_format": "string",
  • "tse_signature": "string",
  • "tse_public_key": "string",
  • "node_id": 0,
  • "customer_tag_uid_hex": "string",
  • "tse_qr_code_text": "string"

  },
• "tax_rate_aggregations": [

  • {

    • "tax_name": "string",
    • "tax_rate": 0,
    • "total_price": 0,
    • "total_tax": 0,
    • "total_no_tax": 0

    }

  ],
• "config": {

  • "title": "string",
  • "issuer": "string",
  • "address": "string",
  • "ust_id": "string"

  },
• "currency_identifier": "string"

}

sumup

initiate customer checkout

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

amount required

number (Amount)

Responses

https://stustapay.de/sumup/create-checkout

Request samples

• Payload

Content type

application/json

{

• "amount": 0

}

Response samples

• 200
• 422

Content type

application/json

{

• "checkout_id": "string"

}

after payment check checkout state

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required

checkout_id required

string (Checkout Id)

Responses

https://stustapay.de/sumup/check-checkout

Request samples

• Payload

Content type

application/json

{

• "checkout_id": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "status": "PENDING"

}