Retrieve a sweep

POST /bank_transfer/sweep/get

The /bank_transfer/sweep/get endpoint fetches information about the sweep corresponding to the given sweep_id.

Request Body

Required

Defines the request schema for /bank_transfer/sweep/get

Parameters

client_id
string
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.
secret
string
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.
sweep_id
required, string
Identifier of the sweep.

Response

BankTransferSweepGetResponse defines the response schema for /bank_transfer/sweep/get

Response Properties

sweep
required, object
BankTransferSweep describes a sweep transfer.
id
required, string
Identifier of the sweep.
created_at
required, string
The datetime when the sweep occurred, in RFC 3339 format.
amount
required, string
The amount of the sweep.
iso_currency_code
required, string
The currency of the sweep, e.g. “USD”.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.