API Reference
Asset librariesConsole

Set up or update sweeping

post
https://api.truelayer-sandbox.com/v3/merchant-accounts//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.

📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Path Params
uuid
required

ID of the merchant account to fetch the settings for

Body Params
integer
required

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

string
enum

How often the available balance will be checked for sweeping,
defaults to daily.

Allowed:
Headers
string
required

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

Responses

Updated about 2 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
*/*
application/problem+json; charset=UTF-8

Updated about 2 months ago