🚧

Sandbox resets affect all users.

If your sandbox is shared or being used by other users within your organization, a sandbox reset will also affect any related objects they may have created or create during the reset processs.

1. Navigate to Sandbox settings

📘

Only those with Manage Organization permissions can reset the sandbox.

You must belong to at least one role assigned the "Manage Organization" permission in order to reset the sandbox.

To reset your sandbox, navigate to Settings > Sandbox and click the Reset Sandbox Data button.

2. Select objects to reset

In the modal, select from the dropdown which group of objects you want to reset:

• All Sandbox Data
• Transactional Data
• Advanced

Data objects have dependencies; we delete them in groups to reduce the risk of dependent data not being deleted together.

All Sandbox Data

If you select 'All Sandbox Data' you will delete the following object types from your Sandbox:

• Transactions
• Sweep Rules
• Payment Orders
• Expected Payments
• Counterparties
• Incoming Payment Details
• Balances
• Returns
• Ledgers
• Account Groups
• Virtual Accounts
• All Accounts Data
• Invoices
• Connections

Reestablish Connections after deletion

🚧

Need to add Connections back in after deleting them?

Set $org_id and $api_key environment variables or replace authentication to replicate default connections into your Sandbox.

curl --request POST \
     --url 'https://app.moderntreasury.com/api/connections' \
     --header 'accept: application/json' \
     --user $org_id:$api_key \
     --header 'content-type: application/json' \
     --data '{"entity_id":"example1","nickname":"GWB"}'

curl --request POST \
     --url 'https://app.moderntreasury.com/api/connections' \
     --header 'accept: application/json' \
     --user $org_id:$api_key \
     --header 'content-type: application/json' \
     --data '{"entity_id":"example2","nickname":"IBB"}'

Transactional Data

If you select 'Transactional Data' you will delete the following object types from your Sandbox:

• Transactions
• Payment Orders
• Expected Payments
• Counterparties
• Incoming Payment Details
• Balances
• Returns
• Ledgers
• Virtual Accounts
• Invoices

Advanced

This is recommended only for advanced users. You can select individual data objects for deletion. Deleting data objects without deleting dependent data objects can result in a broken sandbox data model.

In the modal, select the objects you want to reset. Use the Toggle All button to conveniently select or deselect all options.

3. Submit & confirm

Once you have selected the desired option, click the Delete button. You will be prompted to confirm your decision. Upon confirmation, a message will be displayed informing you that an email will be sent once the reset has been completed.

🚧

Do not create objects while reset is in progress.

While the reset is in progress, do not create any new objects as you may experience inconsistent results.

4. Email confirmation

You will receive an email confirmation once the reset is complete.