> ## Documentation Index
> Fetch the complete documentation index at: https://developer.me-cash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

Welcome to the meCash API Reference!

Everything here runs against Sandbox, so line up the essentials below and you can be testing endpoints in minutes.

## Before you start

1. Copy your **Sandbox API key** from **Developers → API Keys** (environment toggle set to Sandbox).
2. Add every server/VPN IP to **Developers → IP Whitelisting → Sandbox**—unlisted IPs return `403`.
3. Use the sandbox base URL `https://sandboxapi.me-cash.com` plus JSON headers (`Content-Type` / `Accept`).

***

## Getting Started

Use the built-in **Try it** panel to send real Sandbox calls without leaving the docs:

<Steps>
  <Step title="Pick an endpoint">
    Choose an endpoint in the sidebar (e.g., **Wallets → Get All Wallets**) and open the **Try it** drawer.
  </Step>

  <Step title="Authenticate once">
    Select the **Sandbox** environment, paste your API key under **Authentication**, and Mintlify auto-adds the header for every request.
  </Step>

  <Step title="Send & inspect">
    Edit path/query/body fields, click **Send**, then review the live response, headers, and generated cURL snippet you can reuse elsewhere.
  </Step>
</Steps>

> **Heads-up:** `401` means the API key is missing or expired. `403` almost always indicates the calling IP still needs to be whitelisted in Sandbox.

***

## Testing & Simulation

Before going live, use our sandbox simulation tools to verify your integration's behavior.

<CardGroup cols={2}>
  <Card title="Fund Virtual Account" icon="money-bill-transfer" href="/virtual-account/fund-virtual-account">
    Simulate incoming transfers to test your collection flow and webhooks.
  </Card>

  <Card title="Simulate Payout Failure" icon="circle-exclamation" href="/api-testing#simulating-payout-states">
    Trigger `payout.failed` webhooks by using "fail" in the transaction remark.
  </Card>
</CardGroup>

***

## API Endpoints

Explore our API categories to find the endpoints you need.

### FIAT API

<CardGroup cols={2}>
  <Card title="Wallets" icon="wallet" href="/wallet/get-all-wallets">
    Manage your multi-currency wallets.

    * Get all wallets
    * Check wallet balances
  </Card>

  <Card title="Quotes" icon="calculator" href="/quote/create-quote">
    Create real-time quotes for currency conversions.

    * Create quotes
    * Get quote details
  </Card>

  <Card title="Payouts" icon="arrow-right" href="/payout/create-payout">
    Send payments to recipients globally.

    * Create payouts
    * Track payout status
  </Card>

  <Card title="Transactions" icon="receipt" href="/transaction/get-transaction">
    Track and monitor your transactions.

    * Get transaction details
    * View transaction history
  </Card>

  <Card title="Virtual Accounts" icon="building" href="/virtual-account/create-virtual-account">
    Create accounts to collect payments.

    * Generate static & dynamic accounts
    * Track incoming payments
  </Card>
</CardGroup>

## Core Concepts

### Base URL

All development and testing should be done using our Sandbox environment.

<CardGroup cols={1}>
  <Card title="Sandbox Base URL" icon="flask">
    `https://sandboxapi.me-cash.com`
  </Card>
</CardGroup>

### Response Format

All API responses follow a consistent JSON format for success and error states.

<AccordionGroup>
  <Accordion title="Successful Response">
    ```json theme={null}
    {
      "status": "success",
      "message": "Operation completed successfully",
      "data": {
        // Response data here
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Error Responses

Error responses include detailed information:

```json theme={null}
{
  "status": "error",
  "errorCode": "INVALID_PARAMETER",
  "message": "A request parameter is invalid."
}
```

## Rate Limits

<CardGroup cols={2}>
  <Card title="Standard Limits" icon="clock">
    * **100 requests per minute** per API key.
    * **1000 requests per hour** per API key.
    * **10,000 requests per day** per API key.
  </Card>

  <Card title="Higher Limits" icon="rocket">
    Contact support for higher rate limits based on your business needs and volume requirements.
  </Card>
</CardGroup>

## Webhooks

Stay updated with real-time notifications using webhooks:

<Accordion title="Supported Events">
  * **Payout Events**: Payment status updates, completion notifications.
  * **Collection Events**: Incoming payment notifications.
  * **Virtual Account Events**: Account creation and payment received.
</Accordion>

<Accordion title="Webhook Security">
  * All webhooks are signed with HMAC-SHA256.
  * Verify webhook signatures to ensure authenticity.
  * Use HTTPS endpoints for webhook URLs.
</Accordion>

## Support

<CardGroup cols={2}>
  <Card title="Documentation" icon="book" href="https://developer.me-cash.com">
    Comprehensive guides and tutorials.
  </Card>

  <Card title="Community" icon="discord" href="https://discord.com/invite/CC5v6h52Wk">
    Join our Discord community for help and discussions.
  </Card>

  <Card title="Support" icon="envelope" href="mailto:support@me-cash.com">
    Get direct support from our team
  </Card>
</CardGroup>

***

**Ready to start building?**

Use the interactive playground above to test the API, or dive into the specific endpoint documentation for detailed implementation guides.