Set up automated sweeping

📘

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

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.

By default, automated sweeping is not enabled.

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.

Note: This API will be unavailable until KYC onboarding has completed.

FieldMandatoryTypeDescription
currencyMandatorystringISO 4217 Currency Code of the account sweep source.
max_amount_in_minorMandatorynumberThe desired maximum amount, specified in terms of the fractional monetary unit of the payment currency, above which funds will be automatically withdrawn.
frequencyOptionalstringHow 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://payouts.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.

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

If you haven't enabled automated sweeping, you'll get a 404 error in the response.

FieldTypeDescription
currencyISO 4217 Currency Code StringCurrency of the account sweep source.
max_amount_in_minornumberThe desired maximum amount, specified in terms of the fractional monetary unit of the payment currency, above which funds will be automatically withdrawn.
ibanstringThe IBAN of the target account that funds will be withdrawn into. Pre-configured & validated as part of KYC onboarding.
{
  "results": [
    {
      "currency": "GBP",
      "max_amount_in_minor": 100000,
      "iban": "GB43BUKB20201666666666",
      "frequency": "daily"
    }
  ]
}

Disable automated account sweeping

Disable automated sweeping for a given currency.

FieldMandatoryTypeDescription
currencyMandatoryISO 4217 Currency Code StringCurrency of the account sweep source.
curl -X POST \
  -H "Authorization: Bearer $access_token" \
  -H "X-TL-Signature: $signature" \
  --data '{"currency": "GBP"}' \
  https://payouts.truelayer-sandbox.com/v1/sweep/remove

Did this page help you?