post https://api.treasuryprime.com/simulation
Simulations are a sandbox environment specific utility to allow for generating mock events against sandbox resources. The simulations are designed to mirror real-world events such as a card being swiped at a point of sale or a debit ACH returning for NSF.
Usage
All /simulation
calls arePOST
requests. Successful requests will return a 202 - Accepted
response. Unsuccessful requests will return a400 - Bad Request
response with a JSON payload containing the error message.
The simulation type is determined by the type
and dictates the rest of the body required for the request.
Parameter | Type | Required? | Description |
---|---|---|---|
type | string | Required | Name of the simulation to trigger. |
simulation | object | Required | The required inputs to generate the simulation. These are simulation type specific. |
Webhooks
All simulations will generate the associated webhooks for the events they are mocking.