TrueLayer
Keep TrueLayer in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
27 ways to read.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with TrueLayer, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Get account balanceRead
Example flow
- TrueLayer · Get account balanceDone
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches TrueLayer.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to TrueLayer
- TrueLayer's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a TrueLayer test account before you go live.
For developers
Technical detail
TrueLayer: consented accounts, balances, transactions, pending, standing orders, direct debits and cards; payments, refunds, mandates, payouts, fee collections and merchant account reads.
TrueLayer API docs- Source actions
- 27
- Data types
- 22
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Account balances1
- Get account balanceSource
Read current and available balance and overdraft for one account.
Account holder info1
- Get account holder infoSource
Read the account holder's name (and email or phone where the bank provides them).
Accounts2
- Get bank accountSource
Read one consented account; account numbers are omitted.
- List consented bank accountsSource
Read account identifiers, type and currency; account numbers and identity data are omitted.
Card balances1
- Get card balanceSource
Read card balance, credit limit, last statement and payment due.
Card pending transactions1
- Read pending card transactionsSource
Read pending transactions for one card.
Card transactions1
- Read card transactionsSource
Read settled transactions for one card, optionally between two dates.
Cards2
- Get cardSource
Read one consented card.
- List cardsSource
Read consented credit and debit cards; only the partial card number is mapped.
Connection metadata1
- Get connection metadataSource
Read the bank, granted scopes and consent dates of this Data API token.
Direct debits1
- List direct debitsSource
Read direct debit mandates on one account.
Fees1
- List fee collectionsSourceIncremental
Read the fees TrueLayer collected from a merchant account (net settlement: one payout to TrueLayer per day).
Mandate constraints1
- Get mandate constraintsSource
Read a mandate's limits and how much of each period has been used.
Mandates2
- Get mandateSource
Read one mandate from the Payments API.
- List mandatesSource
Read variable recurring payment mandates, optionally for one user.
Merchant account transactions1
- List merchant account transactionsSourceIncremental
Read settled payments, payouts and refunds on a merchant account for reconciliation.
Merchant accounts1
- List merchant accountsSource
Read TrueLayer merchant accounts and balances; account numbers are omitted.
Payment links1
- Get payment linkSource
Read one payment link from the Payments API.
Payment refunds2
- Get payment refundSource
Read one payment refund from the Payments API.
- List payment refundsSource
Read the refunds of one merchant account payment; does not create refunds.
Payments1
- Get paymentSource
Read the status of a Payments API v3 payment; account identifiers are omitted.
Payouts2
- Get payoutSource
Read the status of an existing payout; does not create payouts.
- List payoutsSourceIncremental
Read executed payouts from a merchant account, including sweeps to your business account and TrueLayer's daily fee collection.
Pending transactions1
- Read pending account transactionsSource
Read pending (not yet settled) transactions for one account.
Refunds1
- List refundsSourceIncremental
Read executed refunds out of a merchant account across all payments, with the refunded payment ID.
Standing orders1
- List standing ordersSource
Read standing orders set up on one account.
Transactions1
- Read account transactionsSource
Read settled transactions for one consented account, optionally between two dates.
Access and limits
- Authentication
- Data API user-consent access token, plus client credentials for Payments API reads
- Plans and access
- A TrueLayer Console application. Data API reads need an end-user consent token; Payments API reads need the client ID and secret with the payments scope. Each Data API endpoint needs its consent scope (accounts, balance, transactions, cards, info, standing_orders, direct_debits). Mandate reads need the recurring_payments:sweeping or recurring_payments:commercial scope.
- Test environment
- Use api.truelayer-sandbox.com with sandbox credentials and the Mock bank; payments tokens then come from auth.truelayer-sandbox.com.
- Rate limits
- Banks limit unattended Data API access (often four calls per account per day under PSD2); TrueLayer returns HTTP 429, which Nexra honours with bounded retries.
- Pagination
- Data API endpoints return all results in one response. Mandates and merchant account transactions follow pagination.next_cursor.
- Provider events
- TrueLayer sends payment, refund, payout and mandate webhooks to the URI registered in Console. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Intentional exclusions: creating, cancelling or authorising payments, refunds, payouts, mandates and payment links; revoking mandates; confirming funds; sweeping settings; and the legacy Payments and PayDirect APIs.
- Data API access tokens expire after one hour. With a stored refresh token (offline_access scope) and the client ID and secret, Nexra renews the token at /connect/token and writes the new access token, expiry and any returned refresh token back to the secure vault; without one, supply a fresh token. An access token stored without an expiry is renewed once on first use so its expiry becomes known.
- Token renewal is compare-and-write: a worker that finds the refresh token already rotated uses the stored pair instead. TrueLayer warns that many refreshes in the same instant can lose the bank's latest token, and the secure vault has no conditional write, so very high concurrency on one connection can still race; reconnect the user if TrueLayer then rejects the refresh token.
- Account numbers, sort codes, IBANs, remitter and beneficiary account details and full card numbers are never mapped.
- Consent acquisition, reconfirmation and reauthentication happen in your app through TrueLayer's auth flow.
- Fees: TrueLayer deducts its fees daily from the merchant account as one payout to TrueLayer (List fee collections) and sends a monthly invoice; the API reports no per-payment fee, and invoices are not available through the API.
- Disputes: open banking payments have no card-style chargebacks and TrueLayer has no dispute list. Indemnity claims on direct debit mandate payments appear as disputedAt and disputedReason on Get payment, and as payment_disputed webhooks.
- Payouts: TrueLayer has no payout list or settlement batches; payouts are read from merchant account transactions, which are themselves the settlement lines. A merchant account ID is required (List merchant accounts).
- Asynchronous Data API requests (async=true with results_uri) are not used; requests run synchronously.
Developer reference
- Create the TrueLayer credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose TrueLayer, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/truelayer and the Connections API.