Similar to our Open Agreement solution but single-acceptance, an agreement with no preset authoriser that can only be accepted once and must be accepted within a predefined time period (expiry).
Note: Unassigned Agreements (UA) can currently only be created via the API and support additional integration options than those available in an Open Agreement.
Unassigned Agreements are shared using the generated link available in the response body. You can then include it in an email, text message, embed it in an iFrame, etc.
Single Use Agreements
Single use agreements allow you to collect a one-off payment. When creating your Unassigned Agreement link via the Split API, set the
single_use flag to
true. The generated link, when viewed by the payer looks like this:
Customise your Unassigned Agreement page
The resulting UA page can be customised to suit your needs. For example, if you already know the name (business or personal) and email of the agreement authoriser, you can pre-fill these fields for the other party and further simplify the process.
Here's a current list of customisation query string parameters:
name: Pre-fill the name or business name of the entity that will be accepting this agreement
success_url: On successful acceptance of this agreement, redirect to this URL (leave blank to let Split handle it)
failure_url: On failure, redirect to this URL (leave blank to let Split handle it)
cancel_url: On cancel, redirect to this URL (leave blank to let Split handle it)
header_title: This would replace "Accept Direct Debit Agreement" in the above example. For single use Agreements, consider changing the title from the default "Direct Debit Agreement" so your customer does not get the impression that they are agreeing to an ongoing direct debit.
iav_tab: Instant bank verification title
other_institution_label: This would replace "Select other institution" in the above example
submit_text: The submit button text
submitting_text: The text as shown on the submit button once clicked
hide_bank_icons: Only a dropdown of banks will be shown
custom_template: Specify the ID of your custom CSS template
In addition to the above options, we support embedding an unbranded & iframe friendly version of the UA page. Simply append the query string parameter to the URL:
embed=1: Removes the frame styling for seamless iFrame usage
whitelabel=1: Removes all Split branding
Example link structure using both options:
iFrame integration is supported. 👍
The UA URL is generated via the API, however the customisation options must be manually appended to the URL.
When defining a custom success URL, Split will append an
agreement_ref=xxxas a query string parameter. You can then use our API to double check the validity of the resulting Agreement reference or enable web hooks to receive a notification of the successful acceptance of the agreement. This is a good way to ensure there's been no tampering.
When defining a custom failure URL, Split will append an errors key with the errors as a query string parameter:
You can include query string parameters in any custom URL. For example, you may want to include your internal
customer_idto the URL so that you can easily relate the agreement result to your customer:
Dynamic HTML classes
form-invalid class is added to the primary submission button. This class is automatically removed when all the required form fields are populated. Combined with your custom CSS template, you can adjust the button behaviour to achieve your desired user experience (e.g Only show the submission button when all fields are populated).