Configuration
Created via ./bin/console config:dump-reference DbpRelayMonoBundle | sed '/^$/d'
# Default configuration for "DbpRelayMonoBundle"
dbp_relay_mono:
database_url: '%env(resolve:DATABASE_URL)%' # Required
# A list of payment type configurations. A payment type is a combination of a payment backend configuration and a payment service provider configuration.
payment_types:
# Prototype
identifier:
# The ID of the payment backend type to use. This references an ID from a mono connector.
backend_type: ~ # Required
# If starting the payment process requires the client to be authenticated
auth_required: false
# Time after which a created or started payment can no longer be continued. In ISO duration format.
session_timeout: PT3600S
# An URL to which to redirect the user to after the process is finished. This overrides any return URL passed by the payment initiator and is not affected by "return_url_expression"
return_url_override: null
# A Symfony expression for validating the return url provided by the initiator. Gets passed an "url" variable. Should return true if the URL is valid.
return_url_expression: 'false'
# A Symfony expression for validating the notify url provided by the initiator. Gets passed an "url" variable. Should return true if the URL is valid.
notify_url_expression: 'false'
# A Symfony expression for validating the PSP return url provided by the initiator. Gets passed an "url" variable. Should return true if the URL is valid.
psp_return_url_expression: 'false'
# The data protection declaration url that will be set on the created payment.
data_protection_declaration_url: null
# The name of the payment recipient, if any.
recipient: null
# If set then it's no longer possible to start a payment for this type. Already active payments using this type are not affected.
disabled: false
# A list of payment methods that are provided to the user
payment_methods:
# Prototype
identifier:
# The PSP contract ID to be used. This references an ID from a mono connector.
contract: ~ # Required
# The PSP contract method ID to be used. This references an ID from a mono connector.
method: ~ # Required
# The display name for the payment method as shown to the user. A message ID for a translations string. In case no ID is found the text is used as is.
name: ~ # Required
# Path to the image - can be an absolute URL, absolute path, or path relative to public directory
image: null
# If set then it's no longer possible to start a payment with this method and they are also not presented to the user. Already active payments using this method are not affected.
disabled: false
# If enabled the payment backend will not be notified when a payment is completed
demo_mode: false
# Various limits for how many payments can be active at the same time
concurrency_limits:
# The maximum of globally active payments that are active, i.e. that have not expired and have not been completed.
max_concurrent_payments: null
# Same as "max_concurrent_payments" but only counts payments from authenticated users
max_concurrent_auth_payments: null
# Same as "max_concurrent_auth_payments" but is a limit per user
max_concurrent_auth_payments_per_user: null
# Same as "max_concurrent_payments" but only counts payments from unauthenticated users
max_concurrent_unauth_payments: null
# Same as "max_concurrent_unauth_payments" but is limited per user IP address
max_concurrent_unauth_payments_per_ip: null
# Configuration for reports about recently completed payments that have not been notified
notify_error:
# The mailer transport DSN to use for sending the email
dsn: ~ # Required
# The sender email address for the reporting emails
from: ~ # Required
# The recipient email address for the reporting emails
to: ~ # Required
# The subject line for the reporting emails
subject: ~ # Required
# The Twig template path for the HTML version of the reporting email
html_template: emails/reporting.html.twig
# The report includes all payments that have been completed in the last "completed_begin" interval (e.g., P1D for 1 day) but have not been notified yet
completed_begin: P1D
# Configuration for recurring email reporting about which payments happened recently.
reporting:
# The mailer transport DSN to use for sending the email
dsn: ~ # Required
# The sender email address for the reporting emails
from: ~ # Required
# The recipient email address for the reporting emails
to: ~ # Required
# The subject line for the reporting emails
subject: ~ # Required
# The Twig template path for the HTML version of the reporting email
html_template: emails/reporting.html.twig
# The report includes all payments that have been created in the last "created_begin" interval (e.g., P1D for 1 day).
created_begin: P1D
# Configuration for when a payment is pruned from the database (after the session has expired). By default, none are pruned.
cleanup:
# Default retention period for payment statuses not explicitly configured. In ISO duration format. Null means no cleanup.
default_retention_duration: null
# Retention period configuration for specific payment statuses
statuses:
# Prototype
-
payment_status: ~ # One of "prepared"; "started"; "pending"; "failed"; "completed", Required
# How long to retain the payment after expiration. In ISO duration format. Null means no cleanup.
retention_duration: null
Example Configuration
dbp_relay_mono:
database_url: '%env(MONO_DATABASE_URL)'
payment_types:
tuition_fee:
backend_type: 'tuition_fee_co'
auth_required: true
session_timeout: 'PT1800S'
recipient: 'Meine Universität'
return_url_override: '%env(MONO_RETURN_URL)%'
psp_return_url_expression: '%env(MONO_PSP_RETURN_URL_EXPRESSION)%'
payment_methods:
payone_creditcard:
contract: 'payone_contract'
method: 'creditcard'
name: payment_methods.credit_card
image: '/bundles/dbprelaymono/svg/credit-cards.svg'
concurrency_limits:
max_concurrent_payments: 100
max_concurrent_auth_payments: 100
max_concurrent_unauth_payments: 25
max_concurrent_auth_payments_per_user: 5
max_concurrent_unauth_payments_per_ip: 5
notify_error:
dsn: '%env(MAILER_TRANSPORT_DSN)%'
from: 'noreply@myuni.at'
to: '%env(MONO_REPORTING_EMAIL_TO)%'
subject: 'Fehler bei der Weitermeldung in CAMPUSonline'
reporting:
dsn: '%env(MAILER_TRANSPORT_DSN)%'
from: 'noreply@myuni.at'
to: '%env(MONO_REPORTING_EMAIL_TO)%'
subject: 'Zusammenfassung der elektronischen Studienbeitragszahlungen'
Builtin Translations
For payment_methods.identifier.name this bundle provides the following list of
builtin translations in the dbp_relay_mono domain:
payment_methods.credit_cardpayment_methods.apple_paypayment_methods.google_paypayment_methods.sofortueberweisung
See ./bin/console debug:translation de --domain dbp_relay_mono for details.
Builtin Icons
For payment_methods.identifier.image this bundle provides the following list
of builtin icons:
/bundles/dbprelaymono/svg/apple-pay.svg/bundles/dbprelaymono/svg/google-pay.svg/bundles/dbprelaymono/svg/klarna-pay.svg/bundles/dbprelaymono/svg/klarna.svg/bundles/dbprelaymono/svg/sofortueberweisung.svg
Disabling Payment Types and Methods
You can disable entire payment types or individual payment methods by setting
the disabled option to true. This prevents new payments from being started
with the disabled type or method, while existing and ongoing payments are not
affected. For users this means that disabled payment methods are not shown in
the payment selection UI, and attempts to start a payment with a disabled type
or method will result in an error as if the type or method did not exist.