Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Bank Transfer

bankTransferSweepGet

POST
/bank_transfer/sweep/get

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

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

BankTransferSweepGetRequest defines the request schema for /bank_transfer/sweep/get

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*integer

Identifier of the sweep.

Formatint64
Range0 <= value
origination_account_id?|

If multiple origination accounts are available, origination_account_id must be used to specify the account that the sweep belongs to.

Response Body

application/json

application/json

curl -X POST "https://example.com/bank_transfer/sweep/get" \  -H "Content-Type: application/json" \  -d '{    "sweep_id": 0  }'
{  "sweep": {    "id": 0,    "transfer_id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",    "created_at": "2020-08-06T17:27:15Z",    "amount": "12.34",    "iso_currency_code": "USD",    "sweep_account": {      "account_number": "123456789",      "routing_number": "111111111"    }  },  "request_id": "saKrIBuEB9qJZno"}

bankTransferCancel POST

Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.

bankTransferList POST

Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.