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

# Quickstart

> From a test key to a paid virtual account and a webhook.

You need a test key (`lsk_test_…`) from your bank's merchant portal, and your server's IP address on its allowlist. Test keys work as soon as you sign up; live keys once the bank approves your business.

**1. Check your key**

`GET /v1/status` tells you which business and mode the key belongs to, and what it may do.

```bash theme={null}
curl https://$MESH_HOST/v1/status \
  -H "X-Api-Key: $MESH_KEY"
```

```json theme={null}
{
  "success": true,
  "data": { "mode": "test", "business_id": "…", "permissions": ["virtual-accounts:write", "…"] },
  "message": "…",
  "request_id": "01a1…"
}
```

**2. Create a collection account**

A static virtual account is a permanent number your payers can pay into.

```bash theme={null}
curl https://$MESH_HOST/v1/virtual-accounts \
  -H "X-Api-Key: $MESH_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "type": "static", "label": "Lekki branch" }'
```

The answer carries the `account_number` to give your payers. Its `name_status` starts `pending` and becomes `confirmed` once the bank's provider has named it.

**3. Set your webhook URL**

Mesh sends every event for the key's mode to one URL.

```bash theme={null}
curl -X PUT https://$MESH_HOST/v1/webhook-endpoint \
  -H "X-Api-Key: $MESH_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://hooks.example.com/larkwave" }'
```

Keep the `secret` (`whsec_…`) from the answer: it is shown only now, and you need it to [verify each webhook](https://docs.mesh.larkwave.org/guides/webhooks.md#verify-the-signature).

**4. Send a test payment**

In test mode the sandbox bank pays the account for you.

```bash theme={null}
curl https://$MESH_HOST/v1/simulations/inflows \
  -H "X-Api-Key: $MESH_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "account_number": "6037000014", "amount_minor": 150000, "sender_name": "Ada Obi" }'
```

Within seconds your URL receives `va.payment.success`, and the payment shows under `GET /v1/virtual-accounts/{accountId}/payments`.

> [!TIP]
>
> Swap the test key for the live key when you go live. Nothing else in your integration changes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.