Create a sweep to push funds out of a balance account with set priorities

POST {{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps

Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.

Request Body

{"counterparty"=>{"transferInstrumentId"=>"SE322JV223222J5HGLCGF2WDV"}, "triggerAmount"=>{"currency"=>"EUR", "value"=>50000}, "currency"=>"EUR", "priorities"=>["fast", "instant"], "category"=>"bank", "schedule"=>{"type"=>"weekly"}, "type"=>"push", "status"=>"active"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"id":"SWPC4227C224555B5FTD2NT2JV4WN9","counterparty":{"transferInstrumentId":"SE322JV223222J5HGLCGF2WDV"},"triggerAmount":{"currency":"EUR","value":50000},"currency":"EUR","priorities":["fast","instant"],"category":"bank","schedule":{"type":"weekly"},"type":"push","status":"active"}