Overview
Learn how to integrate with the single interface to access all of TrueLayer's Payments Products.
The TrueLayer Payment API v3 is a single interface to access all of TrueLayer's Payment Products in all supported geographies.
As it is currently in Private Beta, it only supports our products in the UK. We will add coverage support as we receive feedback from our Beta customers and continue with our development.
This product is in private beta and is currently available to a limited number of clients. To join our private beta, contact Client Care
Choose your integration
There are many ways to use TrueLayer's payment products. You can choose an integration path that suits your needs the best:
Integration path | Description |
|---|---|
Hosted Payments Pages | The Hosted Payment Page presents a web user interface that makes it simple and easy to accept payments from your users. |
Mobile SDKs | The mobile SDK for iOS and Android, you can quickly add open banking payments to your app. Our mobile SDK integrates with our Payments API, making it simple to get up and running. |
API only | The API provides a server-side integration if you wish to build your own UI, integrate into your existing UI, or would like to have more flexible customisations. |
Before you begin
To authenticate to our API, you'll need your client_id and client_secret for the environment you are using (live or sandbox). You can find these values in the Console. You can get your sandbox client_id in the App Settings. If you don't have your client_secret, you can generate a new one. Note that generating a new client_secret will invalidate the previous one.
To upgrade your account to the live environment:
- Go to your Console > Payment API v3.
- Select the Go to live env button.
- Go to App Settings.
- Copy the
client_id. - Contact our sales team and give them your live
client_id.
Not regulated as a PISP?
If you are unregulated as a Payment Initiation Service Provider (PISP) and you wish to use your own UI, then you must display some additional information in your payment journey. See our payments user interface guidance for more information.
See also
To get support for the Payments API:
- Check the Payments API FAQs.
- Contact Client Care for help.
- Glossary
Updated 11 days ago