---
title: "List Bulk Funding Settlements"
method: GET
path: "/settlements"
tags: ["Settlements"]
---

# List Bulk Funding Settlements

`GET /settlements`

## Request

- Base URL: `https://bo-api.drivewealth.io/back-office`
- URL: `https://bo-api.drivewealth.io/back-office/settlements`
- Auth: HTTP bearer

Retrieves a list of Bulk Funding Settlements.

## Query parameters

- `from` string, required
- `to` string, required
- `status` 'PENDING' | 'APPROVED' | 'SUCCESSFUL': The current status of the settlement.
- `settlementProfileID` string: A settlement profile identifier that links to a specific bank account for fund settlement.
- `limit` integer
- `offset` string
- `direction` 'prev' | 'next'

## Response `200`

Retrieving a list of Bulk Funding Settlements was Successful.

- SingleSettlementReports
  - `pageSize` integer: The amount of results on the page.
  - `limit` integer: The maximum number of results per page.
  - `settlements` SingleSettlementDetails[]
    - `cashBalance` number: Cash balance in the partner's settlement account. Only present if the partner is enabled for automated settlements processing.
    - `cashSettlementAccountID` string: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account identifier.
    - `cashSettlementAccountNo` string: Account number of the cash settlement account. Only present if the partner is enabled for automated settlements processing.

---

[API](https://skmtc.dev/drivewealth/apis/money-movement-apis.md) - [All operations](https://skmtc.dev/drivewealth/apis/money-movement-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/drivewealth/apis/money-movement-apis/revisions/c94fbd154054?raw)