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

# 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` 'FBO' | 'WUBS_DECOUPLED'
- `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` 'USD' | 'EUR' | 'GBP' | 'CAD' | 'HKD'
    - `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` Notifications2
      - `minimumBalance` integer
    - `autoTopUpConfig` AutoTopUpConfig2
      - `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 — The two character ISO country code for the associated account
    - `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.

## 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

## Changes

- **2021-05-04** `5280d78a309d` — 1 warning, 4 info
  - removed the optional property `content/items/archived` from the response with the `200` status
  - added the new optional `query` request parameter `includeUserDeleted`
  - added the optional property `content/items/deleted` to the response with the `200` status
  - added the optional property `content/items/deletedAt` to the response with the `200` status
  - …1 more
- **2020-09-25** `dd71433847a6` — 4 breaking, 24 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `401`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - …24 more
- **2020-06-24** `aded220b0d7b` — 7 breaking, 6 warning, 4 info
  - the response's body type changed from `object` to no type for status `404`
  - the response property `content/items/autoTopUpConfig` became optional for the status `200`
  - the response property `content/items/fundingRef` became optional for the status `200`
  - the response property `content/items/physicalAccountName` became optional for the status `200`
  - …13 more
- **2020-03-19** `10644a139f81` — 1 info
  - endpoint added
- **2019-07-15** `ced8e167a97c` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/sourceAccounts/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/da77064fe233/schema)