The /bank_transfer/sweep/list endpoint fetches information about the sweeps matching the given filters.
643 matches
46 actions
Plaid
46 actions
- Create a deposit switchPOSTv1.0.0
- Create a deposit switch without using Plaid ExchangePOSTv1.0.0
- Create a new identity verificationPOSTv1.0.0
- Create an Asset ReportPOSTv1.0.0
- Create Asset Report Audit CopyPOSTv1.0.0
- Create Link Delivery sessionPOSTv1.0.0
- Create payment consentPOSTv1.0.0
- Create payment profilePOSTv1.0.0
- Create payment recipientPOSTv1.0.0
- Creates a new end customer for a Plaid reseller.POSTv1.0.0
- Get balance of your Bank Transfer accountPOSTv1.0.0
- Get CategoriesPOSTv1.0.0
- Get details of all supported institutionsPOSTv1.0.0
- Get details of an institutionPOSTv1.0.0
- Get Link Delivery sessionPOSTv1.0.0
- Get payment consentPOSTv1.0.0
- Get payment detailsPOSTv1.0.0
- Get payment profilePOSTv1.0.0
- Get payment recipientPOSTv1.0.0
- List a historical log of user consent eventsPOSTv1.0.0
- List a user’s connected applicationsPOSTv1.0.0
- List dashboard usersPOSTv1.0.0
- List Identity VerificationsPOSTv1.0.0
- List payment recipientsPOSTv1.0.0
- List sweepsPOSTv1.0.0
- Retrieve a dashboard userPOSTv1.0.0
- Retrieve a PDF Asset ReportPOSTv1.0.0
- Retrieve a summary of an individual's employment informationPOSTv1.0.0
- Retrieve a sweepPOSTv1.0.0
- Retrieve a user's payroll informationPOSTv1.0.0
- Retrieve an Asset ReportPOSTv1.0.0
- Retrieve an Asset Report Audit CopyPOSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an ItemPOSTv1.0.0
- Retrieve identity dataPOSTv1.0.0
- Retrieve identity match scorePOSTv1.0.0
- Retrieve Identity VerificationPOSTv1.0.0
- Retrieve information about a Plaid applicationPOSTv1.0.0
- Retrieve information from the bank accounts used for employment verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verification in PDF formatPOSTv1.0.0
- Retrieve Link sessions for your userPOSTv1.0.0
- Search employer databasePOSTv1.0.0
- Search institutionsPOSTv1.0.0
- Update the scopes of access for a particular applicationPOSTv1.0.0
Finance/Plaid
List sweeps
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
{
"type": "object",
"description": "BankTransferSweepListRequest defines the request schema for `/bank_transfer/sweep/list`",
"properties": {
"client_id": {
"type": "string",
"description": "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
},
"count": {
"type": "integer",
"description": "The maximum number of sweeps to return."
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "The end datetime of sweeps to return (RFC 3339 format)."
},
"origination_account_id": {
"type": "string",
"description": "If multiple origination accounts are available, `origination_account_id` must be used to specify the account that the sweeps belong to."
},
"secret": {
"type": "string",
"description": "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "The start datetime of sweeps to return (RFC 3339 format)."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
{
"type": "object",
"description": "BankTransferSweepListResponse defines the response schema for `/bank_transfer/sweep/list`",
"required": [
"request_id",
"sweeps"
],
"properties": {
"request_id": {
"type": "string",
"description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
},
"sweeps": {
"type": "array",
"items": {
"type": "object",
"description": "BankTransferSweep describes a sweep transfer.",
"required": [
"id",
"created_at",
"amount",
"iso_currency_code"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount of the sweep."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the sweep occurred, in RFC 3339 format."
},
"id": {
"type": "string",
"description": "Identifier of the sweep."
},
"iso_currency_code": {
"type": "string",
"description": "The currency of the sweep, e.g. \"USD\"."
}
}
}
}
}
}