Skip to main content

Before you begin

Make sure you have:
  • A registered meCash Business account for your company.
  • Legal and compliance documents handy (KYB form, director IDs, proof of address, BVN).
  • A dedicated IP address or CIDR block for outbound traffic.
  • A publicly reachable HTTPS endpoint that can receive webhook events.

Get started with meCash API in 5 steps

Follow this quickstart guide to integrate meCash API into your application.

Step 1: Create Your Account

meCash Business sign-up screen highlighting the create account button
  1. Visit meCash Business.
  2. Select Sign Up, complete the registration form, and set a strong password.
  3. Verify your email address to unlock the dashboard.
  4. Assign teammates under Team Management so they can collaborate.
  • Fill out the KYB form in full—partial submissions delay approvals.
  • Upload clear copies of:
    • Business registration certificate
    • Valid government-issued ID for the business director
    • Recent proof of address (utility bill or bank statement)
The first and last name on the form must match the BVN you submit.
  • Provide your BVN for account verification to unlock an NGN account.
  • Once approved, the account details appear under Accounts → NGN.
The BVN name must exactly match the first and last name submitted in KYB.

Step 2: Generate Your API Keys

Developer dashboard showing sandbox API key creation
  1. Log in to the meCash Business dashboard.
  2. Open Developers → API Keys.
  3. Confirm the Sandbox environment is selected, then click Create a Key.
  4. Label the key to match your environment and copy it to your secrets manager.
Never expose API keys in client-side code or public repos.
From the dashboard you can toggle between the sandbox and production environments. The environment URLs are:
  • Production: https://api.me-cash.com - For live transactions.
  • Sandbox: https://sandboxapi.me-cash.com - For testing and development.
Request a production key after KYB approval and final testing.

Step 3: Configure Security

IP whitelisting configuration page listing approved IP addresses
  1. Go to Developer section in your dashboard.
  2. Navigate to IP Whitelisting.
  3. Add your outbound server IPs or CIDR ranges.
  4. Save the configuration.
Calls from non-whitelisted IPs are rejected automatically.

Step 4: Set up your webhook

Click the Create Webhook button at the top-right corner to launch the configuration modal for a new endpoint.
Create webhook dialog in the meCash dashboard
  • Enter the publicly accessible URL where you want to receive webhook events.
  • Ensure the endpoint accepts HTTPS POST requests and responds within 10 seconds.
  • Return an HTTP 2XX status code to acknowledge receipt and prevent retries.
Webhook configuration form requesting callback URL
After clicking Confirm, your webhook appears in the list with its current status. Use the dashboard to pause, resume, rotate the signing secret, or trigger test events whenever you need a validation payload.

Step 5: Make Your First API Call

Start by listing wallets in the sandbox to confirm connectivity:
List wallets in sandbox
export MCASH_API_KEY="YOUR_SANDBOX_API_KEY"

curl -sS https://sandboxapi.me-cash.com/v1/wallets \
  -H "Content-Type: application/json" \
  -H "x-api-key: $MCASH_API_KEY"
A successful call returns a 200 response with your available wallets:
Example response
{
  "data": [
    {
      "wallet_id": "WALLET-12345",
      "currency": "NGN",
      "balance": "0.00"
    }
  ]
}
Keep sandbox and production keys separate. Rotate keys periodically via the dashboard.

Next steps

Now that you have basic setup complete, explore these key features:
Need help? Contact us at [email protected] or join our Discord community.