SETSimple Easy Transactions
SET DocsAPI reference and complianceUpdated 2026-11-09
Browse: SET API (Platforms)

SET API (Platforms) · Wallets

Sweep a wallet now

POST/v1/wallets/{id}/sweeps

Key scope: write · Success: 201

Sweeps now: by default everything above keep, split by the rule. With allocations and no rule, this is a one-off split payout across the customer's own banks.

Path parameters

id stringrequired
The wallet's id.

Headers

Idempotency-Key string
Optional. The same key and body run once; a replay answers with Idempotent-Replayed: true. Kept 24 hours.

Body

amount decimal string
Default: the balance less keep.
allocations [{ bankAccount, share }]
Overrides the rule's split for this sweep.

Errors

  • 400 allocations_invalid
  • 400 bank_account_invalid
  • 403 operator_cannot_withdraw
  • 404 wallet_unknown
  • 401 api_key_required
  • 401 api_key_invalid
  • 401 api_key_wrong_mode
  • 403 scope_missing
  • 429 rate_limited

All codes: Errors.