POST /sandbox/bank_transfer/simulate
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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
client_id |
String | No |
Your Plaid API |
event_type |
String | Yes |
The asynchronous event to be simulated. May be: An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:
|
bank_transfer_id |
String | Yes |
Plaid’s unique identifier for a bank transfer. |
failure_reason |
Object | No |
The failure reason if the type of this transfer is |
failure_reason.description |
String | No |
A human-readable description of the reason for the failure or reversal. |
failure_reason.ach_return_code |
String | No |
The ACH return code, e.g. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.