What it runs
Each folder is independent. Run one at a time.
Prerequisites
- Postman, app or web.
- A sandbox API key with
simulations:write,accounts:read,counterparties:write,payouts:read,payouts:write,deposits:readandevents:read. The Webhook folder also needswebhook_subscriptions:writeandwebhook_deliveries:read.full_accesscovers all of them. See Scopes. - For the Webhook folder, a public HTTPS receiver that answers with a 2xx status. A temporary inbox such as webhook.site is enough.
Run it
1
Download the files
Get
augustus-v1.postman_collection.json and augustus-sandbox.postman_environment.json from the repository.2
Import them
In Postman, select Import and add both files. The Augustus Banking API Sandbox Flows collection and the Augustus Sandbox environment appear.
3
Set your key
Select the Augustus Sandbox environment and set
apiKey to your sandbox key. Set webhookUrl only if you run the Webhook folder.4
Run a folder
Open the collection, choose a rail folder, select Run folder and keep the requests in their order.
The collection accepts only
https://api.sandbox.augustus.com (or a local loopback address) as base URL, so it cannot run against production. Set cleanupAccount to false to keep the generated account and inspect it in the Dashboard. Cleanup is best-effort: if a run fails before its last steps, the account stays open. Closed accounts and created counterparties remain visible in the sandbox history.