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

# Quickstart

> Get started with the CashQ API in minutes

## Get started in three steps

Make your first API request and start integrating CashQ money transfers into your application.

### Step 1: Get your API credentials

<Steps>
  <Step title="Request sandbox access">
    Fill out the [Sandbox Request Form](https://cashqkyc.typeform.com/to/ysRjOpwP) to get your sandbox API credentials.

    <Info>
      You'll receive your API key via email within 24 hours.
    </Info>
  </Step>

  <Step title="Understand the environments">
    CashQ provides two environments:

    | Environment | Base URL                    | Purpose                 |
    | ----------- | --------------------------- | ----------------------- |
    | Sandbox     | `https://api.cashqbot.com/` | Testing and development |
    | Production  | Contact support             | Live transactions       |

    <Warning>
      Data created in sandbox will not affect production and cannot be transferred between environments.
    </Warning>
  </Step>
</Steps>

### Step 2: Make your first API request

<Steps>
  <Step title="Check your balance">
    Test your API credentials by checking your merchant balance:

    ```bash theme={null}
    curl -X GET 'https://api.cashqbot.com/api/agent_balance' \
      -H 'API-KEY: your_api_key_here'
    ```

    <Check>
      A successful response will return your balance in cents:

      ```json theme={null}
      {
        "balance": {
          "balance": 0,
          "overdraft": 2000
        }
      }
      ```
    </Check>
  </Step>

  <Step title="Verify recipient KYC status">
    Check if a recipient is KYC verified and their transfer limits before sending money:

    ```bash theme={null}
    curl -X GET 'https://api.cashqbot.com/api/kyc/16175551212' \
      -H 'API-KEY: your_api_key_here'
    ```

    <Check>
      A successful response will show the recipient's KYC status and limits:

      ```json theme={null}
      {
        "kyc_verify": true,
        "money_limit": "8990",
        "kyc_url": ""
      }
      ```
    </Check>

    <Note>
      Phone numbers must be in E.164 format without the `+` sign: `[country code][subscriber number]`
    </Note>

    <Warning>
      **Important:** Always verify KYC status before sending transfers. Recipients must be KYC verified and the transfer amount must not exceed their `money_limit`.
    </Warning>
  </Step>
</Steps>

### Step 3: Send your first transfer

<Steps>
  <Step title="Check the transfer">
    Before sending money, validate the transfer details:

    ```bash theme={null}
    curl -X POST 'https://api.cashqbot.com/api/checkTransfer' \
      -H 'API-KEY: your_api_key_here' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "123456789",
        "sender_phone": "5551234567",
        "receiver_phone": "5551234568",
        "amount": "5.0",
        "receiver_country": "MX"
      }'
    ```
  </Step>

  <Step title="Execute the transfer">
    Once validated, execute the money transfer:

    ```bash theme={null}
    curl -X POST 'https://api.cashqbot.com/api/transfer' \
      -H 'API-KEY: your_api_key_here' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "123456789",
        "sender_phone": "5551234567",
        "receiver_phone": "5551234568",
        "amount": "5.0",
        "receiver_country": "MX"
      }'
    ```

    <Check>
      You'll receive a response with the transfer status and ID.
    </Check>
  </Step>
</Steps>

## Next steps

Now that you've made your first API request, explore the full API capabilities:

<CardGroup cols={2}>
  <Card title="KYC Verification" icon="shield-check" href="/payout/kyc">
    Learn about KYC requirements and verification limits.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/balance">
    Explore all available API endpoints and parameters.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn about API authentication and security best practices.
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/concepts/errors">
    Understand error responses and how to handle them.
  </Card>

  <Card title="Status Codes" icon="list" href="/api-reference/status-codes">
    Reference guide for transfer status codes.
  </Card>

  <Card title="Transaction Flow" icon="diagram-project" href="/transaction-flow">
    Complete payment flow combining Payin and Payout APIs.
  </Card>
</CardGroup>

## Need help?

<Card title="Contact Support" icon="envelope" href="mailto:support@mycashq.com" horizontal>
  Have questions or need production credentials? Reach out to our team.
</Card>