TrueLayer

TrueLayer Merchant Accounts API

Merchant account management and balance

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.truelayer.com/docs/payments-api-basics
📖
GettingStarted
https://docs.truelayer.com/docs/create-a-payment

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/openapi/truelayer-merchant-accounts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/json-schema/truelayer-payment-schema.json

Other Resources

🔗
Webhooks
https://docs.truelayer.com/docs/payments-api-webhook-reference
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/rules/truelayer-rules.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/json-ld/truelayer-context.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/vocabulary/truelayer-vocabulary.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/truelayer/refs/heads/main/graphql/truelayer-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/truelayer-merchant-accounts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

truelayer-merchant-accounts-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: TrueLayer Payments Mandates Merchant Accounts API
  description: The TrueLayer Payments API v3 enables applications to create and manage open banking payments, payouts, refunds, and variable recurring payment mandates across the UK and EU. TrueLayer connects to 69+ banks and provides a unified interface for instant bank payments using open banking rails. Authentication requires signed requests with private keys and OAuth2 access tokens.
  version: 3.0.0
  contact:
    name: TrueLayer Support
    url: https://docs.truelayer.com
  termsOfService: https://truelayer.com/legal/
servers:
- url: https://api.truelayer.com
  description: TrueLayer Production API
- url: https://api.truelayer-sandbox.com
  description: TrueLayer Sandbox (testing)
security:
- BearerAuth: []
tags:
- name: Merchant Accounts
  description: Merchant account management and balance
paths:
  /v3/merchant-accounts:
    get:
      summary: List Merchant Accounts
      description: Returns all merchant accounts for the integration.
      operationId: listMerchantAccounts
      tags:
      - Merchant Accounts
      responses:
        '200':
          description: List of merchant accounts
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/MerchantAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v3/merchant-accounts/{id}:
    get:
      summary: Get Merchant Account
      description: Retrieve a merchant account and its current balance.
      operationId: getMerchantAccount
      tags:
      - Merchant Accounts
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Merchant account details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v3/merchant-accounts/{id}/transactions:
    get:
      summary: List Merchant Account Transactions
      description: Returns transactions for a merchant account.
      operationId: listMerchantAccountTransactions
      tags:
      - Merchant Accounts
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: from
        in: query
        description: Start date-time filter (ISO 8601)
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        description: End date-time filter (ISO 8601)
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: Pagination cursor
        schema:
          type: string
      responses:
        '200':
          description: Merchant account transactions
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        type:
                          type: string
                          enum:
                          - payment
                          - payout
                          - refund
                        amount_in_minor:
                          type: integer
                        currency:
                          type: string
                        status:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                  next_cursor:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    MerchantAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
        currency:
          type: string
        account_identifiers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              sort_code:
                type: string
              account_number:
                type: string
              iban:
                type: string
        available_balance_in_minor:
          type: integer
          description: Available balance in minor currency units
        current_balance_in_minor:
          type: integer
          description: Current balance including pending settlements
  responses:
    Unauthorized:
      description: Unauthorized - invalid token or missing signature
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
              title:
                type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                type: string
              title:
                type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 access token with payments scope