Similar to our Open Agreement solution but single-use: 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 supports additional integration options.

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.

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 : Prefill the name or business name of the entity that will be approving the payment request
  • email : Prefill the email of the entity that will be approving the payment request
  • success_url : On successful payment, 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 
  • iav_tab : Instant bank verification title
  • other_institution_label 
  • 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

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:
https://go.split.cash/unassigned_agreements/7778f2f03-416d-4ed5-8ac2-27eeef757c73/invitation?embed=1&whitelabel=1 

Notes

  • 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=xxx  as 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: http://www.example.com/failed?errors=contact.name_too_long .
  • You can include query string parameters in any custom URL. For example, you may want to include your internal customer_id   to the URL so that you can easily relate the agreement result to your customer: http://www.example.com/success?customer_id=1234 .

Javascript events

You can optionally handle the success and/or failure events via dispatched event from the postMessage API:

  • handle_success=1 : When appended to the agreement URL and the customer successfully accepts the agreement, the success event will be broadcast via the postMessage web API.
  • handle_failure=1 : When appended to the agreement URL and the customer accepts the agreement but fails for some reason, the failure event will be broadcast via the postMessage web API.

For both above events, no redirect or render will happen. It's up to you to redirect the user or render a new view.

Example boilerplate:

function receive(event) {
  // Check to make sure it's coming from us
  if (event.origin !== "https://go-sandbox.split.cash") {
    return;
  }

  // See how the payload is formed, particularly the data key
  console.log(event)
  // Do stuff like redirect.
  window.location.replace("https://example.com");
}

// Listen for message from the iFrame
window.addEventListener('message', receive, false)

Did this answer your question?