Pricing Templates
Log in Sign up
Integrations / Plaid / ...

POST /sandbox/payment/simulate

Use the /sandbox/payment/simulate endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook.

Servers

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.
webhook String Yes

The webhook url to use for any payment events triggered by the simulated status change.
status String Yes

The status to set the payment to.

Valid statuses include:

  • PAYMENT_STATUS_INITIATED
  • PAYMENT_STATUS_INSUFFICIENT_FUNDS
  • PAYMENT_STATUS_FAILED
  • PAYMENT_STATUS_EXECUTED
  • PAYMENT_STATUS_SETTLED
  • PAYMENT_STATUS_CANCELLED
  • PAYMENT_STATUS_REJECTED
payment_id String Yes

The ID of the payment to simulate
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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy