{ "opencollection": "1.0.0", "info": { "name": "Plaid bank transfer/", "version": "2020-09-14_1.517.0" }, "items": [ { "info": { "name": "Plaid", "type": "folder" }, "items": [ { "info": { "name": "Plaid Create a bank transfer as a processor", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/processor/bank_transfer/create", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor" }, { "info": { "name": "Plaid Retrieve a bank transfer", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/get", "body": { "type": "json", "data": "{}" } }, "docs": "The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`." }, { "info": { "name": "Plaid Create a bank transfer", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/create", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/bank_transfer/create` endpoint to initiate a new bank transfer." }, { "info": { "name": "Plaid List bank transfers", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/list", "body": { "type": "json", "data": "{}" } }, "docs": "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.\n" }, { "info": { "name": "Plaid Cancel a bank transfer", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/cancel", "body": { "type": "json", "data": "{}" } }, "docs": "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`." }, { "info": { "name": "Plaid List bank transfer events", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/event/list", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/)." }, { "info": { "name": "Plaid Sync bank transfer events", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/event/sync", "body": { "type": "json", "data": "{}" } }, "docs": "`/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/)." }, { "info": { "name": "Plaid Retrieve a sweep", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/sweep/get", "body": { "type": "json", "data": "{}" } }, "docs": "The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`." }, { "info": { "name": "Plaid List sweeps", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/sweep/list", "body": { "type": "json", "data": "{}" } }, "docs": "The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters." }, { "info": { "name": "Plaid Get balance of your Bank Transfer account", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/balance/get", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.\n\nThe transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.\n\nNote that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Fu" }, { "info": { "name": "Plaid Migrate account into Bank Transfers", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/bank_transfer/migrate_account", "body": { "type": "json", "data": "{}" } }, "docs": "As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to ob" }, { "info": { "name": "Plaid Simulate a bank transfer event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/bank_transfer/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox." }, { "info": { "name": "Plaid Manually fire a Bank Transfer webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/bank_transfer/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment." } ] } ], "bundled": true }