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

# Definir Alias

> POST /v2/naas/submerchants/alias — define o slug de URL usado nos links de pagamento estáticos.

Define o slug de URL usado para construir links de pagamento estáticos para um sub-merchant. O alias se torna o `{slug}` em `https://checkout.noxpay.io/pay/{slug}/{link_path}`.

<Warning>
  Este endpoint opera no nível do merchant master. **Não inclua `correlation_id` no envelope** — passe-o dentro do `payload`.
</Warning>

O alias pode ser atualizado a qualquer momento — ele sobrescreve o valor anterior.

## Campos do payload

| Campo            | Tipo          | Obrigatório | Descrição                                                                   |
| ---------------- | ------------- | ----------- | --------------------------------------------------------------------------- |
| `correlation_id` | string (UUID) | Sim         | UUID retornado por [Cadastrar Sub-merchant](/pt/api-reference/naas/enroll). |
| `alias`          | string        | Sim         | Slug de URL. Apenas letras, números, `_` e `-`. Máx 32 caracteres.          |

## Response `200 OK`

```json theme={null}
{ "alias": "acmepay" }
```

**`400`** — `correlation_id` ou `alias` ausente ou inválido; `alias` falha na validação de formato.

**`404`** — `correlation_id` não encontrado ou não pertence a este merchant master.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://checkout.noxpay.io/v2/naas/submerchants/alias \
    -H "api-key: <key>" \
    -H "X-Signature: <assinatura-do-corpo>" \
    -H "Content-Type: application/json" \
    -d '{
      "timestamp": "2026-05-27T14:30:00Z",
      "payload": {
        "correlation_id": "a1b2c3d4-e5f6-4789-abcd-000000000001",
        "alias": "acmepay"
      }
    }'
  ```

  ```python Python theme={null}
  import requests

  body, sig = sign_envelope({
      "correlation_id": "a1b2c3d4-e5f6-4789-abcd-000000000001",
      "alias": "acmepay",
  })
  response = requests.post(
      "https://checkout.noxpay.io/v2/naas/submerchants/alias",
      headers={"api-key": "<key>", "X-Signature": sig, "Content-Type": "application/json"},
      data=body,
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const { body, signature } = signEnvelope({
    correlation_id: "a1b2c3d4-e5f6-4789-abcd-000000000001",
    alias: "acmepay",
  });
  const response = await fetch("https://checkout.noxpay.io/v2/naas/submerchants/alias", {
    method: "POST",
    headers: { "api-key": "<key>", "X-Signature": signature, "Content-Type": "application/json" },
    body,
  });
  const data = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  { "alias": "acmepay" }
  ```

  ```json 400 theme={null}
  { "error": "alias contains invalid characters" }
  ```
</ResponseExample>