tm.paymentscenario

1 min

Payment scenarios group one or more payment methods of a specific type (immediate or deferred payment, like wire transfers). Payment scenarios are also frequently used to group payment method that trigger extra order fees (like a credit card fee for example)

Fields

FIELD	TYPE	DESCRIPTION
id	int	Unique ID
name	mlstring	Name of the payment scenario
shortdescription	mlstring	Short description of the payment scenario, will be shown to customers
feedescription	mlstring	A very short description of the fee that is applicable.
logo	string	Logo url
internalremark	string	An internal remark, which is never shown to customers. Can be used to distinguish identically named payment scenarios. For example: You could have two VISA scenarios, one for the web sales and one for the box office, each will have different fee configurations. Both will be named VISA, this field can be used to distinguish them.
typeid	int	Type for the payment scenario. Can be 'Immediate payment' (2701), 'Mollie bank transfer' (2702), 'Regular bank transfer' (2703), 'Deferred online payment' (2704), 'Deferred other' (2705). References: tm.systemtype
overdueparameters	PaymentscenarioOverdueParameters	Rules that define when an order becomes overdue. Not used for type 2701.
expiryparameters	PaymentscenarioExpiryParameters	Rules that define when an order becomes expired. Not used for type 2701.
visibility	string	Parameter that sets the visibility of this scenario, can be either 'FULL' or 'API'.
availability	PaymentscenarioAvailability	Rules that define in what conditions this payment scenario is available
paymentmethods	[int]	Set of payment methods that are linked to this payment scenario. Depending on the type, this field has different usage.
ordermailtemplateid_paymentinstruction	int	Link to the order mail template that will be sent as payment instruction. Can be 0 to indicate that no mail should be sent. Not used for type 2701. References: tm.ordermailtemplate
ordermailtemplateid_overdue	int	Link to the order mail template that will be sent when the order is overdue. Can be 0 to indicate that no mail should be sent. Not used for type 2701. References: tm.ordermailtemplate
ordermailtemplateid_expiry	int	Link to the order mail template that will be sent when the order is expired. Can be 0 to indicate that no mail should be sent. Not used for type 2701. References: tm.ordermailtemplate
bankaccountnumber	string	Bank account number to be used. Only used for type 2703 (Regular bank transfer)
bankaccountbic	string	BIC code for the bank account number. Only used for type 2703 (Regular bank transfer)
bankaccountbeneficiary	string	Beneficiary for the bank account number. Only used for type 2703 (Regular bank transfer)
mailorganization	bool	Send mail to organization if known
createdts	timestamp	Created timestamp
lastupdatets	timestamp	Last updated timestamp
isarchived	bool	Whether or not this item is archived