TRtruelayer
Merchant accounts

Get sweeping settings

Get the automatic sweeping settings for a merchant account.

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

Path parameters

idstring uuid required

Unique ID for the Merchant Account

Example:AB8FA060-3F1B-4AE8-9692-4AA3131020D0

ID of the merchant account to fetch the settings for

Response

Automatic sweeping settings

max_amount_in_minorinteger 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.

Example response

{
  "currency": "GBP",
  "destination": {
    "iban": "GB32CLRB04066800012315"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.