---
title: "Get list of source accounts"
method: GET
path: "/v3/sourceAccounts"
tags: ["Source Accounts"]
---

# Get list of source accounts

`GET /v3/sourceAccounts`

List source accounts.

## Query parameters

- `physicalAccountName` string
- `physicalAccountId` string, uuid
- `payorId` string, uuid
- `fundingAccountId` string, uuid
- `includeUserDeleted` string, boolean
- `type` string — Type of source account. One of the following values: FBO, PRIVATE
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

List Source Account response

- ListSourceAccountResponseV3 — List Source Accounts Response Object
  - `page` PagedUserResponsePage
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` ListSourceAccountResponseV3Links[]
    - `rel` string
    - `href` string
  - `content` SourceAccountResponseV3[]
    - `id` string, uuid, required — Source Account Id
    - `balance` integer — Decimal implied
    - `currency` string — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `fundingRef` string — The funding reference (will not be set for DECOUPLED accounts).
    - `physicalAccountName` string — The physical account name (will not be set for DECOUPLED accounts).
    - `railsId` string, required
    - `payorId` string, uuid
    - `name` string
    - `pooled` boolean — The pooled account flag (will not be set for DECOUPLED accounts).
    - `customerId` string, nullable
    - `physicalAccountId` string, uuid — The physical account id (will not be set for DECOUPLED accounts).
    - `notifications` NotificationsV3
      - `minimumBalance` integer
    - `autoTopUpConfig` AutoTopUpConfigV3
      - `enabled` boolean, required — Is auto top-up enabled? automatically trigger funding to top-up the source account balance when the balance falls below the configured minimum level.
      - `minBalance` integer, nullable — When the payor balance falls below this level then auto top-up will be triggered. Note - This is in minor units.
      - `targetBalance` integer, nullable — When the payor balance falls below the min balance then auto top-up will request funds bring the balance to this level. Note - this is in minor units.
      - `fundingAccountId` string, uuid — Id of funding account from which to pull funds when auto top-up is triggered. Note - if this is not set then auto top-up is effectively disabled.
    - `type` string, required
    - `country` string — Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.
    - `deleted` boolean — An optional flag for whether the source account has been deleted. Only present in the response if true.
    - `userDeleted` boolean — An optional flag for whether the source account has been deleted by a user. Only present in the response if true.
    - `deletedAt` string, date-time — An optional timestamp when the source account has been deleted. Only present in the response if deleted.
    - `transmissionTypes` string[] — List of supported transmission types.

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — The resource was not found or is no longer available

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/versions/05c3f09fc50a/schema)