Console basics

Use Console to manage your different integrations and quickly access payments data.

To use TrueLayer products, you need to sign up to Console. When you first sign up for Console, a dialog displays which contains instructions on how to get started.

In Console, you and users within your organisation can:

The Console homepage displays options for integrating different products.

The screen that displays when you sign into Console.

The screen that displays when you sign into Console.

📘

Don't see an email from us? Check spam

Sometimes, the verification email that arrives when you first set up an account with us gets caught in spam filters.

Allowlist truelayer.com domains to ensure that the email you receive when you first create an account arrives in your regular inbox.

The Console menu

The menu to the left in Console contains options to set up, manage and monitor your integration.

Icon in menuDescription
Icon

App settings

Set, view or reset your client_id and client_secret and edit your redirect URIs.
Icon

Data API

Configuration options for the Data API. You can:

- Build auth links for your users.

- Customise the UI of your auth dialog.
Icon

Verification API

Learn how to get started with the Verification API.
Icon

Payments

Configuration and administration options for the Payments API v3. You can:

- Upload a public key to sign requests.
- Edit Webhook URIs.
- View your merchant account balances.
- Set up sweeping from your merchant account.
- Customise the UI for the hosted payment page and payment links.
- View a dashboard of payments made through your integration.
- Payments also contains UI customisation options for the legacy Payments API v2
Icon

Payouts API

Configuration options for the legacy Payouts API.

Payouts are also supported with the Payments API v3.
Icon

PayDirect API

Configuration options for the legacy PayDirect API.

All PayDirect API functionality is supported by the Payments API v3.
Icon

Team members

A list of users with access to your application.

People with the Owner or Admin role can edit existing users' permissions or invite new users to the application.
Icon

Documentation

Navigate to this documentation site.
Icon

Support

Open the support chat dialog, where you can find answers to common questions or ask a question.
Icon

Status page

Navigate to the service status page, where you can check the availability of TrueLayer's APIs.

You can also:

  • Switch between applications by clicking the name of your app in the top bar and selecting the app you want to switch to in the dropdown menu.
  • Toggle Live in the top-right corner to switch between sandbox and production environments.
  • Sign out or set up multi-factor authentication by clicking your initials in the top-right corner.

🚧

Legacy options

Some of the options in Console are specific to legacy products, particularly PayDirect, the Payments API v2, and the Payouts API.

If you are using the Payments API v3, you can find all customisation options for all Payments products (Payments, Payouts, VRP, Signup+) in the Payments section.