plaid

(Deprecated) Simulate a bank transfer event in Sandbox

Changed on

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.

post/sandbox/bank_transfer/simulate

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/bank_transfer/simulate
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

bank_transfer_idstring required

Plaid's unique identifier for a bank transfer.

event_typestring required

The asynchronous event to be simulated. May be: posted, failed, or reversed.

An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:

pending --> failed

pending --> posted

posted --> reversed

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 94406d9a4d27Revision changes
    • info

      endpoint deprecated