Toggle Partial Sweep

Last updated August 5th, 2026

patch api.withmono.com/v3/payments/mandates/{id}/partial-sweep/toggle
v1.0

This resource is used to enable or disable Partial Sweep for an existing Mono Sweep mandate.

When toggled on, partial debits occur across the customer's linked accounts. When toggled off, full sweep is enabled and a full debit is attempted.

Feature access

Partial Sweep needs to be separately enabled for your account. To request access, reach out to sales@mono.co.

Path Params
Body
Headers

Request

12345678
curl --request PATCH \
     --url https://api.withmono.com/v3/payments/mandates/id/partial-sweep/toggle \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'mono-sec-key: string' \
     --data '{
          "allow_partial_sweep": true
}'

Response

Choose an option from the drop down or click one of these buttons to see an example:

Did this page help you?