Authorise a payment mandate

After you create a mandate, you receive a response that contains a resource_token, a user id and a mandate id.

{
  "id": "{The mandate ID}",
  "user": {
    "id": "{The user ID}"
  },
  "resource_token": "The resource token for the mandate"
}

You need both values to start the authorisation journey for your user.

Like with a payment, your user must authorise any mandates you create before any money can be sent. They do this by authorising the mandate with their their banking provider. To do this, use a browser redirect to send the user to their bank.

There are two options for authorisation: a prebuilt TrueLayer UI, or a direct API integration.

Authorise a mandate with a TrueLayer UI

The first option is to use a TrueLayer web or mobile UI for authorisation. These are simpler to integrate than building your own authorisation UI and customisable to match your brand.

TrueLayer authorisation UIs use the resource_token you get when you generate a mandate and display screens for your user to authorise the mandate. They include extra information so your user can understand what a mandate is, and are compliant with any applicable regulation.

Authorise a mandate with TrueLayer HPP

A common example of authorising a mandate is through the creation of the Hosted Payment Page (HPP).

While very similar to the standard HPP URL structure (link), for mandates make sure you are including the mandate_id (instead of the payment_id).

For eg.

https://payment.truelayer.com/mandates#mandate_id={mandate_id}&resource_token={resource_token}&return_uri={return_uri}