Build your own pay-in authorisation UI

📘

Simpler integration with TrueLayer UIs

Authorisation and the related actions are handled automatically if you integrate with the hosted payment page, embedded payment page or a TrueLayer mobile UI. This includes embedded flows, which you must use a TrueLayer auth flow for unless you are regulated as a PISP.

User authorisation is separate to request signing and payment or mandate creation, and there is no TrueLayer library for it.

Direct API integration for payment authorisation

On a basic level, to integrate directly with the TrueLayer Payments API v3, you need to develop logic to perform the following:

1. Use a payment or mandate id in a POST request to start the authorisation flow.
2. Check the response to see what the next required action is.
   The response also contains the data required to complete the action.
3. Based on the next action type, provide appropriate data via a POST request.
   You may need to develop an interface for users to provide this data.
4. Repeat steps 2 and 3 if the response says another action is required.
   If no action is required, the response returns the wait action and payment authorisation is complete.

Authorisation flow actions

In order to authorise a payment or mandate, your direct API integration needs to have logic to handle the different types of authorisation action. These actions relate to tasks such as selecting a provider, providing additional information for authorisation in certain regions, or redirecting a customer. Learn more about the different types of authorisation action.

Different authorisation integration flows

What logic your direct API integration needs to be able to handle depends upon factors such as which provider selection type your payment has and regional payment requirements. Learn more about the different flows you may have to integrate.