TRtruelayer
Merchant accounts

Set up or update sweeping

Set the automatic sweeping settings for a merchant account.

At regular intervals, any available balance in excess of the configured max_amount_in_minor is withdrawn to a pre-configured IBAN.

post/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

Headers

Tl-Signaturestring required

A JWS with detached content, signed with your private key. See Request Signing

Request body

max_amount_in_minorinteger required

A 'cent' value representing the max desired amount, above which funds will be automatically withdrawn, e.g. 100 == 1GBP

frequency'hourly' | 'every_3_hours' | 'every_6_hours' | 'every_12_hours' | 'daily' | 'weekly' | 'fortnightly'

How often the available balance will be checked for sweeping.

Response

Automatic sweeping enabled

Changes

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