GuidesAPI Reference
Guides
API Reference

Execute account sweep payout

Automatically consolidates and transfers available balances from multiple beneficiary accounts to a designated destination account in a single operation. This is commonly used for treasury management, revenue collection, or balance consolidation. You can sweep all beneficiaries or specify a subset. The destination can be a master account, external bank account, or cryptocurrency wallet. Sweep operations are atomic - either all transfers succeed or all fail. Useful for end-of-day settlements, collecting marketplace fees, or pooling funds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to perform a sweep payout operation, consolidating balances from multiple beneficiaries.

string
enum

Currency code for the sweep operation.

string
enum

Filter to determine which beneficiaries to include in the sweep.

Allowed:
beneficiariesSubSet
array of objects

List of specific beneficiaries to include when filter is SUBSET.

beneficiariesSubSet
string
enum

Payment rail to use for the sweep payout.

string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json