POST /sandbox/transfer/refund/simulate

Use the /sandbox/transfer/refund/simulate endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as /transfer/event/sync or /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 `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.
`refund_id`	String	Yes	Plaid’s unique identifier for a refund.
`event_type`	String	Yes	The asynchronous event to be simulated. May be: `refund.posted`, `refund.settled`, `refund.failed`, or `refund.returned`. An error will be returned if the event type is incompatible with the current refund status. Compatible status --> event type transitions include: `refund.pending` --> `refund.failed` `refund.pending` --> `refund.posted` `refund.posted` --> `refund.returned` `refund.posted` --> `refund.settled` `refund.posted` events can only be simulated if the refunded transfer has been transitioned to settled. This mimics the ordering of events in Production.
`webhook`	String	No	The webhook URL to which a `TRANSFER_EVENTS_UPDATE` webhook should be sent.
`test_clock_id`	String	No	Plaid’s unique identifier for a test clock. If provided, the event to be simulated is created at the `virtual_time` on the provided `test_clock`.
`failure_reason`	Object	No	The failure reason if the event type for a transfer is `"failed"` or `"returned"`. Null value otherwise.
`failure_reason.description`	String	No	A human-readable description of the reason for the failure or reversal.
`failure_reason.failure_code`	String	No	The failure code, e.g. `R01`. A failure code will be provided if and only if the transfer status is `returned`. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.
`failure_reason.ach_return_code`	String	No	The ACH return code, e.g. `R01`. A return code will be provided if and only if the transfer status is `returned`. For a full listing of ACH return codes, see Transfer errors.
`secret`	String	No	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.

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.