Single API
Overview
Seamlessly collect and aggregate user-consented Open Banking data from multiple banks into a single profile for simplified management and accessibility.
Each Single API endpoint returns a different slice of that profile.
Prerequisites
- Authentication: Obtain an access token using the Client Credentials flow (see Getting Started → Authentication). Use scope
single_apiwhen generating the token. - Open Banking Prerequisites: Create an Accounts Link for the target institution and wait until it is Active (see Getting Started → Open Banking Prerequisites). Every Single API endpoint resolves consented data from the
PSUIdyou used there. - Subscription: Subscribe to Single API in your chosen environment.
Endpoints
| Endpoint | Returns |
|---|---|
| ListProfileAccounts | Every consented account across all linked banks, with balances |
| ListProfileBalances | The current balance per account, with type and as-of timestamp |
| ListProfileTransactions | Full transaction history, normalized, with the running balance |
| ListProfileBeneficiaries | Every saved payee, with destination IBAN and receiving bank |
| ListProfileDirectDebits | The direct debit mandates on one account |
| ListProfileParties | Who owns or is authorised on one account, with role and identity |
| ListProfileScheduledPayments | Future-dated payments set up from one account, not yet executed |
| ListProfileStandingOrders | Recurring transfers on one account, with amount, frequency and next date |
The first four cover the whole profile and take a required PSUId query parameter. The rest are per account: they take the account_id in the path and treat psu_id as optional. All of them accept an optional x-request-id header and return the same error shapes.
Ready to build with Single API?
Create a sandbox app, grab your credentials, and make your first call in minutes.