Quick Start
Before you start, complete Platform Account Setup. You need a sandbox API key and a sandbox Transfer API key for the steps in this guide.
This quick start runs against the sandbox environment. Every request uses the sandbox base URL,
https://api-staging.muralpay.com, with a sandbox API key (it starts withmural_test_). Payouts in the sandbox are simulated and move no real funds. See Sandbox Environment.
Prefer an API client? Import the Mural OpenAPI spec into Postman or another API client. Then set the base URL to
https://api-staging.muralpay.comand follow the steps below.
Building with an AI coding tool? Connect to the Mural MCP server first. Then give your AI tool the link to this page and ask it to run through the quick start for you.
This quick start walks you through onboarding one of your customers, a business, and taking it through the full payout flow in the sandbox. You create an Organization for the business, approve it, fund its Account, and send a payout to a bank account in Colombia.
- Onboard your end user: create an Organization for your end user, have them accept the Terms of Service, and manually approve their Compliance Review. Mural then creates an Account for the Organization.
- Fund the Account: get the Account ID and simulate a payin.
- Get payout fees: quote the fees and exchange rate for the payout.
- Send a payout: create and execute a Payout Request, then track it to completion.
The examples read your keys, and the IDs from earlier steps, from shell variables. Set your keys now:
export MURAL_API_KEY="mural_test_..."
export MURAL_TRANSFER_API_KEY="..."Each step tells you which ID to save from its response, and the variable to save it in: ORGANIZATION_ID, ACCOUNT_ID, or PAYOUT_REQUEST_ID.
Updated 23 days ago