---
title: "Get sweeping settings"
method: GET
path: "/v3/merchant-accounts/{id}/sweeping"
tags: ["Merchant accounts"]
---

# Get sweeping settings

`GET /v3/merchant-accounts/{id}/sweeping`

## Request

- Base URL: `https://api.truelayer-sandbox.com`
- URL: `https://api.truelayer-sandbox.com/v3/merchant-accounts/{id}/sweeping`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.truelayer.com/connect/token` scopes: `payments`

Get the automatic sweeping settings for a merchant account.

## Path parameters

- `id` string, uuid, required: Unique ID for the Merchant Account

## Response `200`

Automatic sweeping settings

- SweepingSettingsConfigured
  - `max_amount_in_minor` integer, required: A 'cent' value representing the max desired amount, above which funds will be automatically withdrawn, e.g. 100 == 1GBP
  - `currency` 'GBP' | 'EUR' | 'PLN', required
  - `frequency` 'hourly' | 'every_3_hours' | 'every_6_hours' | 'every_12_hours' | 'daily' | 'weekly' | 'fortnightly', required: How often the available balance will be checked for sweeping.
  - `destination` AccountIdentifierIban, required: The international bank account number.
    - `type` 'iban', required: The type of scheme identifier.
    - `iban` string, required: Valid International Bank Account Number (no spaces). Consists of a 2 letter country code, followed by 2 check digits, and then by up to 30 alphanumeric characters (also known as the BBAN). pattern: `^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$`

## Other responses

- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Account Not Found or Automatic sweeping not enabled
- `500`: Unknown Error

---

[API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)