Name | Type | Description | Notes |
---|---|---|---|
orders | \OpenAPIWebForm\Client\Model\DirectDebitOrder[] | Direct debit orders | |
execution_date | \DateTime | Execution date for the direct debit(s), in the format <code>YYYY-MM-DD</code>. May not be in the past. | |
batch_booking_preferred | bool | This field is only relevant when you pass multiple orders. It determines whether the orders should be processed by the bank as one collective booking (in case of <code>true</code>), or as separate bookings (in case of <code>false</code>). Note that it is subject to the bank whether it will regard the field. | [optional] [default to true] |
profile_id | string | The profile to be applied to the web form.<br/>This will overwrite the default profile, if such a profile exists. | [optional] |
redirect_url | string | The URL where the end-user will be redirected to after completing the bank login and (possibly) the SCA on the bank's website. Must always be provided by mandators with <code>FULLY_LICENSED</code> or <code>PISP</code> license type, and may not be provided by mandators with other license types. Find more info in the <a target='_blank' href='https://documentation.finapi.io/webform/Licensed-customers-using-the-Web-Form.2832302195.html'>Web Form 2.0 Public Documentation</a>.<br/><br/><strong>NOTE:</strong> Please note that this URL is used during the bank authentication flow. If you would like to provide a URL to which the end user will get redirected at the <strong>end of the web form flow</strong>, please check out the <a href='https://documentation.finapi.io/webform/For-best-results!.2477654019.html#Forbestresults!-Enhanceend-userexperience!' target='_blank'>Web Form 2.0 Public Documentation</a>. | [optional] |
callbacks | \OpenAPIWebForm\Client\Model\Callbacks | [optional] | |
receiver | \OpenAPIWebForm\Client\Model\DirectDebitWithAccountReceiver | ||
direct_debit_type | string | Type of the direct debit; either <code>BASIC</code> or <code>B2B</code> (Business-To-Business). | |
sequence_type | string | Sequence type of the direct debit. Possible values:<br/>• <code>OOFF</code> - means that this is a one-time direct debit order;<br/>• <code>FRST</code> - means that this is the first in a row of multiple direct debit orders;<br/>• <code>RCUR</code> - means that this is one (but not the first or final) within a row of multiple direct debit orders;<br/>• <code>FNAL</code> - means that this is the final in a row of multiple direct debit orders. |