Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

TrueLayer

Connect with TrueLayer to leverage secure open banking services. This integration allows seamless interaction with TrueLayer's API to manage various financial processes.

CategoryPayment Processing
AuthenticationOAuth 2.0
Version0.2.0
Published scopes10 published scopes
Last updatedSeptember 24, 2026

Overview

Connect TrueLayer with Flows360

Connect with TrueLayer to leverage secure open banking services. This integration allows seamless interaction with TrueLayer's API to manage various financial processes.

Use the TrueLayer connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 39 actions and no declared triggers.

Available actions

  • Create payout
  • Get payout
  • Start authorization flow
  • Submit payments return parameters
  • Create Mandate
  • List Mandates
  • Get Mandate
  • Start Authorization Flow
  • Plus 31 additional declared actions.

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: TrueLayer
  • Package: @activepieces/piece-truelayer@0.2.0
  • Exact artifact digest: sha256:956185936ceee48fc0724c0b3ac9b1a884615bc71f914ebdbcc8d2de6be23740
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

OAUTH2. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Create payout (create-payout), Pay out from one of your merchant accounts. Classification: read.
  • Get payout (get-payout), Returns payout details. Classification: read.
  • Start authorization flow (start-payout-authorization-flow), Start the authorization flow for a payout. This API can be called using the resource_token associated with the payout you are trying to fetch. Classification: read.
  • Submit payments return parameters (submit-payments-provider-return-parameters), Submit direct return query and fragment parameters returned from the provider. Classification: read.
  • Create Mandate (create-mandate), Create a new mandate. This API must be called using a backend bearer token. Classification: read.
  • List Mandates (list-mandate), List all the mandates associated with the client. This API must be called using a backend bearer token. Classification: read.
  • Get Mandate (get-mandate), Returns a mandate with the stated ID. This endpoint can be called either by the regular backend token or the mandate token for that mandate. Classification: read.
  • Start Authorization Flow (start-mandate-authorization-flow), Start the authorization flow for a mandate. This API can be called using either the mandate_token associated with the mandate or a backend bearer token. Classification: read.
  • Submit consent (submit-consent-mandate), Submit the consent given by the user. This API can be called using either the mandate_token associated with the mandate or a backend bearer token. Classification: read.
  • Submit provider selection (submit-mandate-provider-selection), Submit the provider details selected by the PSU. This API can be called using either the mandate_token associated with the mandate or a backend bearer token. Classification: read.
  • Revoke Mandate (revoke-mandate), Revoke a mandate. This API must be called using a backend bearer token. Classification: read.
  • Confirm Mandate Funds (confirm-mandate-funds), Confirm that the PSU has the given funds. This API can be called using the mandate_token associated with the mandate or using a backend bearer token. Classification: read.
  • Get Mandate Constraints (get-constraints), Retrieve the constraints defined on the mandate, as well as the current utilization of those constraints within the periods. Classification: read.
  • List Merchant Accounts (list-operating-accounts), List all your TrueLayer merchant accounts. There might be more than one account per currency. Classification: read.
  • Get Merchant Account (get-operating-account), Get the details of a single merchant account. Classification: read.
  • Get Transactions (merchant-account-get-transactions), Get the transactions of a single merchant account. If pagination is missing, add a header tl-enable-pagination: true to enable pagination. Classification: read.
  • Set Up or Update Sweeping (merchant-account-setup-sweeping), Set the automatic sweeping settings for a merchant account. At regular intervals, any available balance in excess of the configured max_amount_in_minor is withdrawn to a pre-configured IBAN. Classification: read.
  • Disable Sweeping (merchant-account-disable-sweeping), Disable automatic sweeping for a merchant account. Classification: read.
  • Get Sweeping Settings (merchant-account-get-sweeping), Get the automatic sweeping settings for a merchant account. Classification: read.
  • Get Payment Sources (get-merchant-account-payment-sources), Get the payment sources from which the merchant account has received payments. Classification: read.
  • Create Payment Link (create-payment-link), Create a new payment link. This API must be called using a backend bearer token. Classification: read.
  • Get Payment Link (get-payment-link), Retrieves payment link details. This API must be called using a backend bearer token. Classification: read.
  • Get Payments (get-payment-link-payments), List all the payments associated with the payment link. This API must be called using a backend bearer token. Classification: read.
  • Create Payment (create-payment), Create a new payment. This API must be called using a backend bearer token. Classification: read.
  • Start Payment Authorization Flow (start-payment-authorization-flow), Start the authorization flow for a payment. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Submit Provider Selection (submit-provider-selection), Submit the provider details selected by the PSU. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Submit Scheme Selection (submit-scheme-selection), Submit the scheme details selected by the PSU. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Submit Form (submit-form), Submit form details filled by the PSU. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Submit Consent (submit-consent), Submit the consent given by the user. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Submit User Account Selection (submit-user-account-selection), Submit the user account selection option given by the user. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Cancel Payment (cancel-payment), Cancel a payment. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Save Payment Account (save-user-account-payment), Save the account details associated with a payment for subsequent re-use. This API can be called using the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Get Payment (get-payment), Returns payment details. This API can be called using either the resource_token associated with the payment or a backend bearer token. Classification: read.
  • Create Payment Refund (create-payment-refund), Refund a merchant account payment, either fully or partially. Classification: read.
  • Get Payment Refunds (get-payment-refunds), Returns all refunds of a payment. Classification: read.
  • Get Payment Refund (get-payment-refund), Returns refund details for a specific payment. Classification: read.
  • Search Payment Providers (search-payment-providers), Returns a list of payment providers. Classification: read.
  • Get Payment Provider (get-payment-provider), Returns payment provider details. This API can be called without the need for authentication. Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

AuthenticationOAuth 2.0
Supported objects39
Supported actionsNot published
TriggersNone published

Authentication

Authentication method: OAuth 2.0

Required scopes

infoaccountsbalancecardstransactionsdirect_debitsstanding_ordersoffline_accesssignupplusverification

Authentication profiles

connection · oauth2

OAuth scopes: info, accounts, balance, cards, transactions, direct_debits, standing_orders, offline_access, signupplus, verification

Supported objects

ObjectReadWriteNotes
Create payout Yes No Pay out from one of your merchant accounts.
Get payout Yes No Returns payout details.
Start authorization flow Yes No Start the authorization flow for a payout. This API can be called using the `resource_token` associated with the payout you are trying to fetch.
Submit payments return parameters Yes No Submit direct return query and fragment parameters returned from the provider.
Create Mandate Yes No Create a new mandate. This API must be called using a backend bearer token.
List Mandates Yes No List all the mandates associated with the client. This API must be called using a backend bearer token.
Get Mandate Yes No Returns a mandate with the stated ID. This endpoint can be called either by the regular `backend token` or the `mandate token` for that mandate.
Start Authorization Flow Yes No Start the authorization flow for a mandate. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
Submit consent Yes No Submit the consent given by the user. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
Submit provider selection Yes No Submit the provider details selected by the PSU. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
Revoke Mandate Yes No Revoke a mandate. This API must be called using a backend bearer token.
Confirm Mandate Funds Yes No Confirm that the PSU has the given funds. This API can be called using the mandate_token associated with the mandate or using a backend bearer token.
Get Mandate Constraints Yes No Retrieve the constraints defined on the mandate, as well as the current utilization of those constraints within the periods.
List Merchant Accounts Yes No List all your TrueLayer merchant accounts. There might be more than one account per currency.
Get Merchant Account Yes No Get the details of a single merchant account.
Get Transactions Yes No Get the transactions of a single merchant account. If pagination is missing, add a header `tl-enable-pagination: true` to enable pagination.
Set Up or Update Sweeping Yes No Set the automatic sweeping settings for a merchant account. At regular intervals, any available balance in excess of the configured `max_amount_in_minor` is withdrawn to a pre-configured IBAN.
Disable Sweeping Yes No Disable automatic sweeping for a merchant account.
Get Sweeping Settings Yes No Get the automatic sweeping settings for a merchant account.
Get Payment Sources Yes No Get the payment sources from which the merchant account has received payments.
Create Payment Link Yes No Create a new payment link. This API must be called using a backend bearer token.
Get Payment Link Yes No Retrieves payment link details. This API must be called using a backend bearer token.
Get Payments Yes No List all the payments associated with the payment link. This API must be called using a backend bearer token.
Create Payment Yes No Create a new payment. This API must be called using a backend bearer token.
Start Payment Authorization Flow Yes No Start the authorization flow for a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Submit Provider Selection Yes No Submit the provider details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Submit Scheme Selection Yes No Submit the scheme details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Submit Form Yes No Submit form details filled by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Submit Consent Yes No Submit the consent given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Submit User Account Selection Yes No Submit the user account selection option given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Cancel Payment Yes No Cancel a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Save Payment Account Yes No Save the account details associated with a payment for subsequent re-use. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
Get Payment Yes No Returns payment details. This API can be called using either the `resource_token` associated with the payment or a backend bearer token.
Create Payment Refund Yes No Refund a merchant account payment, either fully or partially.
Get Payment Refunds Yes No Returns all refunds of a payment.
Get Payment Refund Yes No Returns refund details for a specific payment.
Search Payment Providers Yes No Returns a list of payment providers.
Get Payment Provider Yes No Returns payment provider details. This API can be called without the need for authentication.
Custom API Call Yes No Make a custom API call to a specific endpoint

Setup

Setup

  1. Add the TrueLayer connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • No provider credential fields are declared by the pinned package.

OAuth scopes

  • info
  • accounts
  • balance
  • cards
  • transactions
  • direct_debits
  • standing_orders
  • offline_access
  • signupplus
  • verification
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-truelayer@0.2.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 39 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required TrueLayer connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-truelayer@0.2.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com