Platform Account Setup
Set up your Parent Organization, team, and API keys before your first API request.
The Mural Platform is your control plane. There you manage your Parent Organization, your team, and your API keys, and you track the Organizations you onboard through the API.
Like your end users, you have an Organization in Mural. Mural calls it your Parent Organization. The Organizations you create for your end users belong to it.
Sandbox and production
Mural has two separate environments. Each has its own platform URL, API base URL, and API keys:
| Environment | Platform URL | API base URL | API key prefix | Transfer API key prefix |
|---|---|---|---|---|
| Sandbox | Sandbox platform | https://api-staging.muralpay.com | mural_test_ | mural_transfer_test_ |
| Production | Production platform | https://api.muralpay.com | mural_live_ | mural_transfer_live_ |
Sandbox and production do not share anything. Your Parent Organization, teammates, and API keys in one environment do not exist in the other, so you must complete the steps below once in each environment. A key works only with the API base URL of the environment that created it.
Start in the sandbox. The Quick Start runs against the sandbox environment, so complete these steps on the sandbox platform first.
1. Sign in to the Mural Platform
Sign in to the sandbox platform.
2. Invite your team
Add the engineers, finance, and operations teammates who will work on your integration or manage your Parent Organization in Settings > Team.
3. Create an API key
Create an API key on the API keys tab of the Developers page.
Every API call authenticates with the API key as a Bearer token in the Authorization header:
curl https://api-staging.muralpay.com/api/accounts \
-H "Authorization: Bearer $MURAL_API_KEY"4. Create a Transfer API key
Create a Transfer API key on the same API keys tab. Requests that move funds need it in the transfer-api-key header, in addition to the API key. These include executing and cancelling a payout request.
Create the Transfer API key before you create Accounts. Accounts created before your Parent Organization has a Transfer API key cannot be used through the API.
Save both keys when you create them. The platform shows the full key only once. If you lose a key, revoke or rotate it on the same tab.
Next step
Your sandbox platform account is ready. Follow the Quick Start to onboard your first end user and send their first payment.
Updated 22 minutes ago