mirror of
https://github.com/pretix/pretix.git
synced 2026-05-09 15:54:03 +00:00
User documentation: More information on payments
This commit is contained in:
Raphael Michel
BIN
doc/screens/event/settings_payment.png
Normal file
BIN
doc/screens/event/settings_payment.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 120 KiB |
9
doc/user/events/settings.rst
Normal file
9
doc/user/events/settings.rst
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
Configuring an event
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
subevents
|
||||||
|
../payments/index
|
||||||
|
taxes
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _taxes:
|
||||||
|
|
||||||
Configuring taxes
|
Configuring taxes
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
|||||||
@@ -9,9 +9,6 @@ wanting to use pretix to sell tickets.
|
|||||||
|
|
||||||
organizers/index
|
organizers/index
|
||||||
events/create
|
events/create
|
||||||
events/subevents
|
events/settings
|
||||||
events/taxes
|
|
||||||
payments/index
|
|
||||||
events/widget
|
events/widget
|
||||||
organizers/domain
|
|
||||||
faq
|
faq
|
||||||
43
doc/user/organizers/account.rst
Normal file
43
doc/user/organizers/account.rst
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
Organizer account
|
||||||
|
=================
|
||||||
|
|
||||||
|
The basis of all your operations within pretix is your organizer account. It represents an entity that is running
|
||||||
|
events, for example a company, yourself or any other institution.
|
||||||
|
Every event belongs to one organizer account and events within the same organizer account are assumed to belong together
|
||||||
|
in some sense, whereas events in different organizer accounts are completely isolated.
|
||||||
|
|
||||||
|
If you want to use the hosted pretix service, you can create an organizer account on our `Get started`_ page. Otherwise,
|
||||||
|
ask your pretix administrator for access to an organizer account.
|
||||||
|
|
||||||
|
You can find out all organizer accounts you have access to by going to your global dashboard (click on the pretix logo
|
||||||
|
in the top-left corner) and then select "Organizers" from the navigation bar on the left side. Then, choose one of the
|
||||||
|
organizer accounts presented, if there are multiple of them:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/list.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
This overview shows you all event that belong to the organizer and you have access to:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/event_list.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
With the "Edit" button at the top, next to the organizer account name, you can modify properties of the organizer
|
||||||
|
account such as its name and display settings for the public profile page of the organizer account:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/edit.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
|
||||||
|
The profile page will be shown as ``https://pretix.eu/slug/`` where ``slug`` is to be replaced by the short form of
|
||||||
|
the organizer name that you entered during account creation and ``pretix.eu`` is to be replaced by your
|
||||||
|
installation's domain name if you are not using our hosted service.
|
||||||
|
|
||||||
|
Instead, you can also use a custom domain for the profile page and your events, for example
|
||||||
|
``https://tickets.example.com/`` if ``example.com`` is a domain that you own. Head to :ref:`custom_domain` to learn
|
||||||
|
more.
|
||||||
|
|
||||||
|
.. _Get started: https://pretix.eu/about/en/setup
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _custom_domain:
|
||||||
|
|
||||||
Using a custom domain
|
Using a custom domain
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
|||||||
@@ -1,112 +1,9 @@
|
|||||||
Organizer accounts and teams
|
Organizer accounts and teams
|
||||||
============================
|
============================
|
||||||
|
|
||||||
Organizer account
|
.. toctree::
|
||||||
-----------------
|
:maxdepth: 2
|
||||||
|
|
||||||
The basis of all your operations within pretix is your organizer account. It represents an entity that is running
|
account
|
||||||
events, for example a company, yourself or any other institution.
|
teams
|
||||||
Every event belongs to one organizer account and events within the same organizer account are assumed to belong together
|
domain
|
||||||
in some sense, whereas events in different organizer accounts are completely isolated.
|
|
||||||
|
|
||||||
If you want to use the hosted pretix service, you can create an organizer account on our `Get started`_ page. Otherwise,
|
|
||||||
ask your pretix administrator for access to an organizer account.
|
|
||||||
|
|
||||||
You can find out all organizer accounts you have access to by going to your global dashboard (click on the pretix logo
|
|
||||||
in the top-left corner) and then select "Organizers" from the navigation bar on the left side. Then, choose one of the
|
|
||||||
organizer accounts presented, if there are multiple of them:
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/list.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
This overview shows you all event that belong to the organizer and you have access to:
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/event_list.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
With the "Edit" button at the top, next to the organizer account name, you can modify properties of the organizer
|
|
||||||
account such as its name and display settings for the public profile page of the organizer account:
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/edit.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
|
|
||||||
The profile page will be shown as ``https://pretix.eu/slug/`` where ``slug`` is to be replaced by the short form of
|
|
||||||
the organizer name that you entered during account creation and ``pretix.eu`` is to be replaced by your
|
|
||||||
installation's domain name if you are not using our hosted service.
|
|
||||||
|
|
||||||
Instead, you can also use a custom domain for the profile page and your events, for example
|
|
||||||
``https://tickets.example.com/`` if ``example.com`` is a domain that you own. In this case, please contact the pretix
|
|
||||||
hosted support or your system administrator to set up the custom domain.
|
|
||||||
|
|
||||||
Teams
|
|
||||||
-----
|
|
||||||
|
|
||||||
We don't expect you to work on your events all by yourself and therefore, pretix comes with ways to invite your fellow
|
|
||||||
team members to access your pretix organizer account. To manage teams, click on the "Teams" link on your organizer
|
|
||||||
settings page (see above how to find it). This shows you a list of teams that should contain at least one team already:
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/team_list.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
If you click on a team name, you get to a page that shows you the current members of the team:
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/team_detail.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
You see that there is a list of pretix user accounts (i.e. email addresses), who are part of the team. To add a user to
|
|
||||||
the team, just enter their email address in the text box next to the "Add" button. If the user already has an account
|
|
||||||
in the pretix system they will instantly get access to the team. Otherwise, they will be sent an email with an invitation
|
|
||||||
link that can be used to create an account. This account will then instantly have access to the team. Users can be part
|
|
||||||
of as many teams as you want.
|
|
||||||
|
|
||||||
In the section below, you can also create access tokens for our :ref:`rest-api`. You can read more on this topic in the
|
|
||||||
section :ref:`rest-auth` of the API documentation.
|
|
||||||
|
|
||||||
Next to the team name, you again see a button called "Edit" that allows you to modify the permissions of the team.
|
|
||||||
Permissions separate into two areas:
|
|
||||||
|
|
||||||
* **Organizer permissions** allow actions on the level of an organizer account, in particular:
|
|
||||||
|
|
||||||
* Can create events – To create a new event under this organizer account, users need to have this permission
|
|
||||||
|
|
||||||
* Can change teams and permissions – This permission is required to perform the kind of action you are doing right now.
|
|
||||||
Anyone with this permission can assign arbitrary other permissions to themselves, so this is the most powerful
|
|
||||||
permission there is to give.
|
|
||||||
|
|
||||||
* Can change organizer settings – This permission is required to perform changes to the settings of the organizer
|
|
||||||
account, e.g. its name or display settings.
|
|
||||||
|
|
||||||
* **Event permissions** allow actions on the level of an event. You can give the team access to all events of the
|
|
||||||
organizer (including future ones that are not yet created) or just a selected set of events. The specific permissions to choose from are:
|
|
||||||
|
|
||||||
* Can change event settings – This permission gives access to most areas of the control panel that are not controlled
|
|
||||||
by one of the other event permissions, especially those that are related to setting up and configuring the event.
|
|
||||||
|
|
||||||
* Can change product settings – This permission allows to create and modify products and objects that are closely
|
|
||||||
related to products, such as product categories, quotas, and questions.
|
|
||||||
|
|
||||||
* Can view orders – This permission allows viewing the list of orders and allindividual order details, but not
|
|
||||||
changing anything about it. This also includes the various exports offered.
|
|
||||||
|
|
||||||
* Can change orders – This permission allows all actions that involve changing an order, such as changing the products
|
|
||||||
in an order, marking an order as paid or refunden, importing banking data, etc. This only works properly if the
|
|
||||||
same users also have the "Can view orders" permission.
|
|
||||||
|
|
||||||
* Can view vouchers – This permission allows viewing the list of vouchers including the voucher codes themselves and
|
|
||||||
their redemption status.
|
|
||||||
|
|
||||||
* Can change vouchers – This permission allows to create and modify vouchers in all their details. It only works
|
|
||||||
properly if the same users also have the "Can view vouchers" permission.
|
|
||||||
|
|
||||||
.. thumbnail:: ../../screens/organizer/team_edit.png
|
|
||||||
:align: center
|
|
||||||
:class: screenshot
|
|
||||||
|
|
||||||
.. _Get started: https://pretix.eu/about/en/setup
|
|
||||||
|
|||||||
65
doc/user/organizers/teams.rst
Normal file
65
doc/user/organizers/teams.rst
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
Teams
|
||||||
|
=====
|
||||||
|
|
||||||
|
We don't expect you to work on your events all by yourself and therefore, pretix comes with ways to invite your fellow
|
||||||
|
team members to access your pretix organizer account. To manage teams, click on the "Teams" link on your organizer
|
||||||
|
settings page (see above how to find it). This shows you a list of teams that should contain at least one team already:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/team_list.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
If you click on a team name, you get to a page that shows you the current members of the team:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/team_detail.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
You see that there is a list of pretix user accounts (i.e. email addresses), who are part of the team. To add a user to
|
||||||
|
the team, just enter their email address in the text box next to the "Add" button. If the user already has an account
|
||||||
|
in the pretix system they will instantly get access to the team. Otherwise, they will be sent an email with an invitation
|
||||||
|
link that can be used to create an account. This account will then instantly have access to the team. Users can be part
|
||||||
|
of as many teams as you want.
|
||||||
|
|
||||||
|
In the section below, you can also create access tokens for our :ref:`rest-api`. You can read more on this topic in the
|
||||||
|
section :ref:`rest-auth` of the API documentation.
|
||||||
|
|
||||||
|
Next to the team name, you again see a button called "Edit" that allows you to modify the permissions of the team.
|
||||||
|
Permissions separate into two areas:
|
||||||
|
|
||||||
|
* **Organizer permissions** allow actions on the level of an organizer account, in particular:
|
||||||
|
|
||||||
|
* Can create events – To create a new event under this organizer account, users need to have this permission
|
||||||
|
|
||||||
|
* Can change teams and permissions – This permission is required to perform the kind of action you are doing right now.
|
||||||
|
Anyone with this permission can assign arbitrary other permissions to themselves, so this is the most powerful
|
||||||
|
permission there is to give.
|
||||||
|
|
||||||
|
* Can change organizer settings – This permission is required to perform changes to the settings of the organizer
|
||||||
|
account, e.g. its name or display settings.
|
||||||
|
|
||||||
|
* **Event permissions** allow actions on the level of an event. You can give the team access to all events of the
|
||||||
|
organizer (including future ones that are not yet created) or just a selected set of events. The specific permissions to choose from are:
|
||||||
|
|
||||||
|
* Can change event settings – This permission gives access to most areas of the control panel that are not controlled
|
||||||
|
by one of the other event permissions, especially those that are related to setting up and configuring the event.
|
||||||
|
|
||||||
|
* Can change product settings – This permission allows to create and modify products and objects that are closely
|
||||||
|
related to products, such as product categories, quotas, and questions.
|
||||||
|
|
||||||
|
* Can view orders – This permission allows viewing the list of orders and allindividual order details, but not
|
||||||
|
changing anything about it. This also includes the various exports offered.
|
||||||
|
|
||||||
|
* Can change orders – This permission allows all actions that involve changing an order, such as changing the products
|
||||||
|
in an order, marking an order as paid or refunden, importing banking data, etc. This only works properly if the
|
||||||
|
same users also have the "Can view orders" permission.
|
||||||
|
|
||||||
|
* Can view vouchers – This permission allows viewing the list of vouchers including the voucher codes themselves and
|
||||||
|
their redemption status.
|
||||||
|
|
||||||
|
* Can change vouchers – This permission allows to create and modify vouchers in all their details. It only works
|
||||||
|
properly if the same users also have the "Can view vouchers" permission.
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/organizer/team_edit.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
@@ -30,3 +30,9 @@ many orders could be processed correctly and how many could not. You can then go
|
|||||||
transfers from your bank statement that are not yet matched to an order. Using the input field and the buttons on the
|
transfers from your bank statement that are not yet matched to an order. Using the input field and the buttons on the
|
||||||
left of each transaction, you can manually enter an order code to match it to or just discard it from the list, e.g.
|
left of each transaction, you can manually enter an order code to match it to or just discard it from the list, e.g.
|
||||||
if the transaction is not related to the event at all.
|
if the transaction is not related to the event at all.
|
||||||
|
|
||||||
|
|
||||||
|
.. tip:: If you aren't afraid of getting a bit more technical and your bank supports the HBCI/FinTS protocol (as most
|
||||||
|
German banks do), you can use `pretix-banktool`_ to fully automate this process.
|
||||||
|
|
||||||
|
.. _pretix-banktool: https://github.com/pretix/pretix-banktool
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _payment-fees:
|
||||||
|
|
||||||
Payment method fees
|
Payment method fees
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
Accepting payments
|
Payment settings
|
||||||
==================
|
================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
settings
|
||||||
overview
|
overview
|
||||||
fees
|
fees
|
||||||
paypal
|
paypal
|
||||||
|
|||||||
@@ -10,25 +10,8 @@ Payment methods are built as pretix plugins. For this reason, you might first ne
|
|||||||
If you host pretix on your own server, you might need to install a plugin first for some of the payment methods listed
|
If you host pretix on your own server, you might need to install a plugin first for some of the payment methods listed
|
||||||
on this page as well as for additional ones.
|
on this page as well as for additional ones.
|
||||||
|
|
||||||
:ref:`stripe`
|
To get an overview of the officially supported payment methods and their pros and cons, head to the `pretix website`_.
|
||||||
Stripe is a US-based company that offers you an easy way to accept credit card payments from all over the world.
|
On these pages, you get more information on how to configure :ref:`stripe`, :ref:`paypal`, and :ref:`banktransfer`.
|
||||||
To accept payments with Stripe, you need to have a Stripe merchant account that is easy to create. Click on the link
|
|
||||||
above to get more details about the Stripe integration into pretix.
|
|
||||||
|
|
||||||
:ref:`paypal`
|
|
||||||
If you want to accept online payments via PayPal, you can do so using pretix. You will need a PayPal merchant
|
|
||||||
account and it is a little bit complicated to obtain the required technical details, but we've got you covered.
|
|
||||||
Click on the link above to learn more.
|
|
||||||
|
|
||||||
:ref:`banktransfer`
|
|
||||||
Classical IBAN wire transfers are a common payment method in central Europe that has the large benefit that it
|
|
||||||
often does not cause any additional fees. However, it requires you to invest some more effort as you need to
|
|
||||||
check your bank account for incoming payments regularly. We provide some tools to make this easier for you.
|
|
||||||
|
|
||||||
SEPA debit
|
|
||||||
In some Europen countries, a very popular online payment method is SEPA direct debit. If you want to offer this
|
|
||||||
option in your pretix ticket shop, we provide a convenient plugin that allows users to enter their SEPA bank
|
|
||||||
account details and issue a SEPA mandate. You will then need to regularly download a SEPA XML file from pretix
|
|
||||||
and upload it to your bank's interface to actually perform the debits.
|
|
||||||
|
|
||||||
|
|
||||||
|
.. _pretix website: https://pretix.eu/about/en/payments
|
||||||
65
doc/user/payments/settings.rst
Normal file
65
doc/user/payments/settings.rst
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
General settings
|
||||||
|
================
|
||||||
|
|
||||||
|
At "Settings" → "Pages", you can configure every aspect related to the payments you want to accept. The upper part
|
||||||
|
of the page shows a number of general settings that affect all payment methods:
|
||||||
|
|
||||||
|
.. thumbnail:: ../../screens/event/settings_payment.png
|
||||||
|
:align: center
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
In particular, these are:
|
||||||
|
|
||||||
|
Payment term in days
|
||||||
|
If a order has been created, it is supposed to be paid within this number of days. Of course, some payment mehtods
|
||||||
|
(like credit card) succeed immediately in most cases, but others don't (like bank transfer) and even credit card
|
||||||
|
payments might fail and you might want to give the customer a chance to try another credit card before losing their
|
||||||
|
ticket. Therefore, we recommend setting a few days here. If you are accepting bank transfers, we wouldn't recommend
|
||||||
|
less than 10 days.
|
||||||
|
|
||||||
|
Last date of payments
|
||||||
|
There is probably no use for payments received after your event, so you can set a date that the payment deadline of
|
||||||
|
a new order will never exceed. This has precendence over the number of days configured above, so if I create an order
|
||||||
|
two days before the configured last date of payments, my payment term will only be two days, not ten. If you have
|
||||||
|
payment methods that always require some time (like bank transfer), you will later be able to selectively disable them
|
||||||
|
once the event comes closer.
|
||||||
|
|
||||||
|
Only end payment terms on weekdays
|
||||||
|
If you check this box, the payment term calculated by the number of days configured above will never end on a Saturday
|
||||||
|
or a Sunday. If it technically would do so, the term is extended to the next Monday. Note that this currently does not
|
||||||
|
take into account national or bank holidays in your country.
|
||||||
|
|
||||||
|
Automatically expire unpaid orders
|
||||||
|
If you check this box, orders will automatically go into "expired" state if the payment term is over and no payment
|
||||||
|
has been received. This means that the tickets will no longer be reserved for the customer and someone else can buy
|
||||||
|
them from the shop again. If you do not check this box, tickets do not become available again automatically, but you
|
||||||
|
can mark orders as expired manually.
|
||||||
|
|
||||||
|
Accept late payments
|
||||||
|
If you check this box, incoming payments will accepted even if the order is in "expired" state -- as long as there
|
||||||
|
still is sufficient quota available and the last date of payments is not yet over. We recommend to check this in most
|
||||||
|
cases.
|
||||||
|
|
||||||
|
Tax rule for payment fees
|
||||||
|
If you pass on the payment method fees to your customers, you will most likely also need to pay sales tax on those
|
||||||
|
fees. Here, you can configure the tax rate. Read :ref:`taxes` for more information.
|
||||||
|
|
||||||
|
Below, you can configure the details of the various payment methods. You can find information on their different settings
|
||||||
|
on the next pages of this documentation, but there are a few things most of them have in common:
|
||||||
|
|
||||||
|
Enable payment method
|
||||||
|
Check this box to allow customers to use this method. At least one method needs to be active to process non-free orders.
|
||||||
|
|
||||||
|
Additional fee (absolute and percentage), Calculate the fee from the total value including the fee
|
||||||
|
These fields allow you to pass fees on to your customers instead of paying them yourselves. Read :ref:`payment-fees`
|
||||||
|
for documentation on how this behaves.
|
||||||
|
|
||||||
|
Available until
|
||||||
|
This allows you to set a date at which this payment method will automatically become disabled. This is useful if you
|
||||||
|
want people to be able to pay by card on the day before your event, but not by bank transfer, because it would not
|
||||||
|
arrive in time.
|
||||||
|
|
||||||
|
Text on invoices
|
||||||
|
If you are using pretix' invoicing feature, this is a text that will be printed on every invoice for an order that
|
||||||
|
uses this payment method. You could use this to tell the accounting department of the invoice receiver that the payment
|
||||||
|
has already been received online or that it should be performed via bank transfer.
|
||||||
Reference in New Issue
Block a user