Root API
Payables Guide

Use Root’s sandbox to validate integrations without real transactions in 7 simple steps.

STEP 1

Get your business email whitelisted to access Root's sandbox environment. Whitelist Now
Create a free developer account on Root's dashboard - no credit card required
There are 2 modes on the platform: Test Mode and Live Mode.
In live mode, you can integrate your actual bank account with Root.
Head over to API Keys in your dashboard and generate a test key.
Copy the key and use it in your request header as:
X-API-KEY: {{your_api_token}}.

STEP 2

Import and Set Up the Postman Collection

Download and install Postman (if you don’t already have it).
Import our official collection from API Documentation .
Open the collection, go to Headers, and paste in the test API key you copied earlier.
Save your settings - requests will now auto-authenticate. Make sure requests inherit auth from the parent collection.

STEP 3

Explore Sample Payees and Payment Methods

In Postman, open the Payees folder and hit the GET /payees endpoint.
Click Send and you’ll see sample payees we’ve already created for you.
Next, explore payout methods by opening the Payment Methods folder and hitting GET /payees/{{payee_id}}/payment-methods.
We’ve pre-configured Postman so {{payee_id}} auto-fills with the first payee’s ID.
Click Send again to see available payment methods for that payee.

STEP 4

Send Your First Simulated Payout

In Postman, go to the Payouts API folder and open POST /payouts.
Under Body, update the amount_in_cents, rail, and payee_id.
Certain Payees trigger predefined simulated cases (e.g., John Settled → Settled status). See the full list of cases at Simulated Scenarios.
Hit Send to create your first payout.

STEP 5

Add More Payees and Payment Methods

In Postman, open the Payees folder and click POST /payees.
In Body, update the name and email fields.
Click Send to create a new payee.
Now, add a payment method by opening POST /payees/{{payee_id}}/payment-methods/push-to-card.
Fill in details like card_number and card_expiry_date.
Click Send to save the payment method.
If you have a client side app, use the Root SDK to ensure you send payment method information safely with PCI compliance standards

STEP 6

Try Out Webhooks (Fully Simulated)

In Postman, open the Webhooks API folder and click POST /webhooks.
Update the url field with your own endpoint where you’d like to receive notifications.
Click Send to register your first webhook.

STEP 7

Go Live 🚀

Upgrade to a live account from your dashboard.
Configure a bank account for your entity.
Generate a live API key and swap out the test key.
Switch your base URL to https://api.useroot.com/.
Ensure you leverage Root SDK in production environment for sending payment method information to comply with PCI standards.
That’s it - you’re now ready to transfer money.