Automated account sweeping

📘
This feature is in private beta and is currently available to a limited number of clients. To join our private beta, contact Client Care.

You can set up automated sweeping to maintain a certain maximum balance in your accounts. By default, automated sweeping is not enabled. You need to finish your KYC onboarding before proceeding with setting up sweep accounts.

Set up or update account sweeping

You can set up automated sweeping for a given currency. At regular intervals, any available balance in excess of the configured max_amount_in_minor is withdrawn to a pre-configured IBAN. The default time interval for automated sweeping is daily.

You can update your sweep configurations (such as changing the frequency or max_amount_in_minor) by making a POST /v1/sweep call with the updated values. We will use the latest value for a given currency.

Field	Mandatory	Type	Description
`currency`	Mandatory	string	ISO 4217 Currency Code of the account sweep source.
`max_amount_in_minor`	Mandatory	number	The desired maximum amount, specified in terms of the fractional monetary unit of the payment currency, above which funds will be automatically withdrawn.
`frequency`	Optional	string	How often the available balance will be checked for sweeping, `daily`, `weekly` or `fortnightly`, defaults to `daily`.

curl -X POST \
  -H "Authorization: Bearer $access_token" \
  -H "X-TL-Signature: $signature" \
  --data '{
    "currency": "GBP",
    "max_amount_in_minor": 100000,
    "frequency": "daily"
  }' \
  https://paydirect.truelayer-sandbox.com/v1/sweep

Get automated account sweeping details

You can obtain all current automated sweeping configurations by making a GET /v1/sweep call. If you haven't enabled automated sweeping, you'll get a 404 error in the response.

Field	Type	Description
`currency`	ISO 4217 Currency Code String	Currency of the account sweep source.
`max_amount_in_minor`	number	The desired maximum amount, specified in terms of the fractional monetary unit of the payment currency, above which funds will be automatically withdrawn.
`iban`	string	The IBAN of the target account that funds will be withdrawn into. Pre-configured & validated as part of KYC onboarding.
`frequency`	string	How often the available balance will be checked for sweeping.

curl -H "Authorization: Bearer $access_token" https://paydirect.truelayer-sandbox.com/v1/sweep

You'll get a response like the following:

{
  "results": [
    {
      "currency": "GBP",
      "max_amount_in_minor": 100000,
      "iban": "GB43BUKB20201666666666",
      "frequency": "daily"
    }
  ]
}

Disable automated account sweeping

Disable automated sweeping for a given currency.

Field	Mandatory	Type	Description
`currency`	Mandatory	ISO 4217 Currency Code String	Currency of the account sweep source

curl -X POST \
  -H "Authorization: Bearer $access_token" \
  -H "X-TL-Signature: $signature" \
  --data '{"currency": "GBP"}' \
  https://paydirect.truelayer-sandbox.com/v1/sweep/remove