Introduction

Welcome

Authentication Server

Access tokens
- Generate or refresh an access tokenpost
- Delete a credentialdelete
Debug ID
- Generate a debug IDpost
- Delete a debug IDdelete

Payments API v3

Payments
Payment links
Payments providers
- Search Payments providerspost
- Get payments providerget
Payouts
Merchant accounts
Mandates
General
- Submit payments return parameterspost

Data API v1

Auth link
- Generate a direct bank authentication linkpost
- Generate a reauthentication linkpost
Connection
Accounts
Cards
Providers
- List providersget

Client Tracking API

Tracked Events
- Get tracked events from a specific authorization flow.get

Signup+

User Data
Generate auth URI
- Generate auth URIpost
- Auth URI expired webhookspost

Verification Api

Account Verification
- Verify account holder name.post

Legacy - Payments API

Payments

Legacy - PayDirect API

Withdrawals
Deposits
- Create depositpost
- Get deposit for userget
Users
- Get userget
- Get user accountsget
Balances
- Get account balancesget
Transactions
- Get transactionsget

Introduction

Welcome

Authentication Server

Access tokens
- Generate or refresh an access tokenpost
- Delete a credentialdelete
Debug ID
- Generate a debug IDpost
- Delete a debug IDdelete

Payments API v3

Payments
Payment links
Payments providers
- Search Payments providerspost
- Get payments providerget
Payouts
Merchant accounts
Mandates
General
- Submit payments return parameterspost

Data API v1

Auth link
- Generate a direct bank authentication linkpost
- Generate a reauthentication linkpost
Connection
Accounts
Cards
Providers
- List providersget

Client Tracking API

Tracked Events
- Get tracked events from a specific authorization flow.get

Signup+

User Data
Generate auth URI
- Generate auth URIpost
- Auth URI expired webhookspost

Verification Api

Account Verification
- Verify account holder name.post

Legacy - Payments API

Payments

Legacy - PayDirect API

Withdrawals
Deposits
- Create depositpost
- Get deposit for userget
Users
- Get userget
- Get user accountsget
Balances
- Get account balancesget
Transactions
- Get transactionsget

Get account

get https://api.truelayer.com/data/v1/accounts/{account_id}

Get a specific account

Path Params

account_id

string

required

unique ID for an account or card

Query Params

async

string

When set to true, data is fetched asynchronously. Expect 202 status code

webhook_uri

uri

When async is set to true, a webhook will be POSTed to the URI provided

Headers

X-Client-Correlation-Id

string

Client-specified ID used to debug requests

X-PSU-IP

string

IP address of the end user requesting data. Necessary to overcome 4 calls per day rate limits

Responses

Response body

object

results

array of objects

results

object

update_timestamp

string

required

Last update time of the data

account_id

string

Unique identifier of the account

account_type

string

Distinguish between personal and business, as well as savings and current accounts.

TRANSACTION SAVINGS BUSINESS_TRANSACTION BUSINESS_SAVINGS

display_name

string

required

Human-readable name of the account

currency

string

required

Currency used for this account or transaction

EUR GBP USD AUD

account_number

object

required

provider

object

required

status

string

Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests

Succeeded Queued Running Failed

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

results_uri

uri

status

string

Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests

Succeeded Queued Running Failed

task_id

string

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Response body

object

error

string

error_description

string

error_details

object

Has additional fields

Headers

object

X-TL-Correlation-Id

string

Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets

X-Credentials-Id

string

Uniquely identifies a connection between the client and a users account(s)

X-Request-Id

string

Not recommended: X-TL-Correlation-Id should be used instead

Cache-Control

string

max-age=n where n number of seconds

Content-Encoding

string

gzip

Content-Type

string

application/json; charset=utf-8

Date

date-time

Date and time the message was sent

Last-Modified

date-time

The date and time a resource was last modified

Content-Security-Policy

string

default-src 'none'; frame-ancestors 'none';

X-Content-Type-Options

string

nosniff

X-Frame-Options

string

deny

X-XSS-Protection

string

1; mode=block

Referrer-Policy

string

no-referrer

Updated almost 4 years ago

Get accounts

Get account balance

Did this page help you?

Language

Credentials

OAuth2

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.truelayer.com/data/v1/accounts/account_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "results": [
3
    {
4
      "update_timestamp": "2017-02-07T17:29:24.740802Z",
5
      "account_id": "f1234560abf9f57287637624def390871",
6
      "account_type": "TRANSACTION",
7
      "display_name": "Club Lloyds",
8
      "currency": "GBP",
9
      "account_number": {
10
        "iban": "GB35LOYD12345678901234",
11
        "number": "12345678",
12
        "sort_code": "12-34-56"
13
      },
14
      "provider": {
15
        "provider_id": "lloyds"
16
      }
17
    }
18
  ]
19
}

Updated almost 4 years ago

Get accounts

Get account balance

Did this page help you?

Headers

Response

X-TL-Correlation-Id	Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets
X-Credentials-Id	Uniquely identifies a connection between the client and a users account(s)
X-Request-Id	Not recommended: `X-TL-Correlation-Id` should be used instead
Cache-Control	`max-age=n` where n number of seconds
Content-Encoding
Content-Type
Date	Date and time the message was sent
Last-Modified	The date and time a resource was last modified
Content-Security-Policy
X-Content-Type-Options
X-Frame-Options
X-XSS-Protection
Referrer-Policy

Introduction
Welcome

Authentication Server
Access tokens
Delete a credentialdelete
Generate or refresh an access tokenpost
Debug ID
Delete a debug IDdelete
Generate a debug IDpost

Payments API v3
Payments
Refund webhooks
Payment webhooks
Get payment refundget
Get payment refundsget
Create payment refundpost
Get paymentget
Cancel paymentpost
Submit consentpost
Submit formpost
Submit scheme selectionpost
Submit provider selectionpost
Start authorization flowpost
Create paymentpost
Payment links
Payment link webhooks
Get paymentsget
Get payment linkget
Create payment linkpost
Payments providers
Get payments providerget
Search Payments providerspost
Payouts
Payout webhooks
Get payoutget
Create payoutpost
Merchant accounts
Merchant account webhooks
Get payment sourcesget
Get sweeping settingsget
Disable sweepingdelete
Set up or update sweepingpost
Get transactionsget
Get merchant accountget
List merchant accountsget
Mandates
Mandate webhooks
Get mandate constraintsget
Confirm fundsget
Revoke mandatepost
Submit provider selectionpost
Submit consentpost
Start authorization flowpost
Get mandateget
List mandatesget
Create mandatepost
General
Submit payments return parameterspost

Data API v1
Auth link
Generate a reauthentication linkpost
Generate a direct bank authentication linkpost
Connection
Extend a connectionpost
User infoget
Connection metadataget
Accounts
Get direct debitsget
Get standing ordersget
Get account pending transactionsget
Get account transactionsget
Get account balanceget
Get accountget
Get accountsget
Cards
Get card pending transactionsget
Get card transactionsget
Get card balanceget
Get cardget
Get cardsget
Providers
List providersget

Client Tracking API
Tracked Events
Get tracked events from a specific authorization flow.get

Signup+
User Data
Get user data by mandate IDget
Get user data by connected accountget
Get user data by paymentget
Generate auth URI
Auth URI expired webhooks
Generate auth URIpost

Verification Api
Account Verification
Verify account holder name.post

Legacy - Payments API
Payments
Get a paymentget
Submit embedded auth flow stepspost
Initiate a paymentpost
Get providersget

Legacy - PayDirect API
Withdrawals
Get withdrawalget
Get user withdrawalget
Create closed-loop withdrawalpost
Create open-loop withdrawalpost
Deposits
Get deposit for userget
Create depositpost
Users
Get user accountsget
Get userget
Balances
Get account balancesget
Transactions
Get transactionsget

Introduction
Welcome

Authentication Server
Access tokens
Delete a credentialdelete
Generate or refresh an access tokenpost
Debug ID
Delete a debug IDdelete
Generate a debug IDpost

Payments API v3
Payments
Refund webhooks
Payment webhooks
Get payment refundget
Get payment refundsget
Create payment refundpost
Get paymentget
Cancel paymentpost
Submit consentpost
Submit formpost
Submit scheme selectionpost
Submit provider selectionpost
Start authorization flowpost
Create paymentpost
Payment links
Payment link webhooks
Get paymentsget
Get payment linkget
Create payment linkpost
Payments providers
Get payments providerget
Search Payments providerspost
Payouts
Payout webhooks
Get payoutget
Create payoutpost
Merchant accounts
Merchant account webhooks
Get payment sourcesget
Get sweeping settingsget
Disable sweepingdelete
Set up or update sweepingpost
Get transactionsget
Get merchant accountget
List merchant accountsget
Mandates
Mandate webhooks
Get mandate constraintsget
Confirm fundsget
Revoke mandatepost
Submit provider selectionpost
Submit consentpost
Start authorization flowpost
Get mandateget
List mandatesget
Create mandatepost
General
Submit payments return parameterspost

Data API v1
Auth link
Generate a reauthentication linkpost
Generate a direct bank authentication linkpost
Connection
Extend a connectionpost
User infoget
Connection metadataget
Accounts
Get direct debitsget
Get standing ordersget
Get account pending transactionsget
Get account transactionsget
Get account balanceget
Get accountget
Get accountsget
Cards
Get card pending transactionsget
Get card transactionsget
Get card balanceget
Get cardget
Get cardsget
Providers
List providersget

Client Tracking API
Tracked Events
Get tracked events from a specific authorization flow.get

Signup+
User Data
Get user data by mandate IDget
Get user data by connected accountget
Get user data by paymentget
Generate auth URI
Auth URI expired webhooks
Generate auth URIpost

Verification Api
Account Verification
Verify account holder name.post

Legacy - Payments API
Payments
Get a paymentget
Submit embedded auth flow stepspost
Initiate a paymentpost
Get providersget

Legacy - PayDirect API
Withdrawals
Get withdrawalget
Get user withdrawalget
Create closed-loop withdrawalpost
Create open-loop withdrawalpost
Deposits
Get deposit for userget
Create depositpost
Users
Get user accountsget
Get userget
Balances
Get account balancesget
Transactions
Get transactionsget

200OK

202Accepted

401Unauthorized

403Access denied

404Not found

429Rate limit exceeded

500Internal server error

501Not implemented

503Service unavailable

504Gateway timeout