MagicDoorAPI
SupportOpen MagicDoor
Bank accounts (Portal)

List sweeps for a bank account

Returns a page of the sweeps that have moved money between this bank account and the payment provider's ledger, newest records first.

GET
https://api.portal.magicdoor.com/company-app/bank-accounts/{bankAccountId}/sweeps

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

bankAccountIdstringrequired

The bank account whose sweeps to list. A Snowflake id sent as a decimal string.

example: 1801556677120004096

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1
pageSizeinteger

How many sweeps to return per page. Between 1 and 100.

default: 50
created.startstring · date-time

Return only sweeps recorded at or after this moment, read in the company's timezone. Give at least one of created.start and created.end when filtering by date.

created.endstring · date-time

Return only sweeps recorded at or before this moment, read in the company's timezone.

Response

200 · A page of sweeps.

itemsSweep[]

The sweeps on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many sweeps a page holds.

totalCountinteger

How many sweeps match across all pages.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · No bank account with that id exists for the caller's company. One belonging to another company reads the same way.