Test Helpers are specialized endpoints designed to enable partners to simulate various external events, scenarios, and states within the sandbox environment, such as receiving deposits, handling withdrawals, or triggering compliance statuses.
Test Helpers are only available in the sandbox environment and will return 404 Not Found if called in production.

​
Why use Test Helpers?

During development and testing, partners often need to simulate external events that would normally be triggered by third-party systems or real-world actions. To simplify these simulations, the Test Helpers enable you to:

Simulate specific events

Quickly and reliably simulate events without waiting for real-world processes (e.g., an incoming bank deposit).

Test edge cases

Test edge cases and failure scenarios like account opening rejection and user sanctioned.

Integration testing

Validate your application’s integration with our APIs in a controlled environment.

Automated testing

Build comprehensive automated test suites with predictable external event simulation.

Event validation

Verify your handling of specific event-driven behaviors and webhook notifications.

Pre-production prep

Prepare and validate your implementation before moving to production.

​
Key concepts

  • Event Triggering: API-driven activation of events to simulate real-world scenarios.
  • Asynchronous Behavior: Many Test Helpers return a 202 Accepted status, indicating that the request has been accepted and processing is asynchronous.
  • Resource Management: Automatically create or modify resources in response to simulated external events.
Before using Test Helpers, keep the following considerations in mind:
  • Behavior in sandbox may differ slightly from production in terms of performance, response times, and event handling.
  • Ensure your integration code is environment-aware to prevent accidental calls to sandbox endpoints from production environments.
Explore the detailed documentation for each Test Helper to start simulating events and scenarios today, streamlining your testing and integration workflow.
You can find these endpoints within the Test Helpers folder, located under each API’s group of endpoints in our API documentation.