> ## 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.

# Gerenciar Whitelist

> POST /v2/naas/whitelist — cria um grupo de carteira ou adiciona um endereço a um grupo existente.

Este endpoint tem dois modos dependendo dos campos fornecidos no payload.

## Criar um grupo de carteira

Forneça apenas `walletName` para criar um novo grupo de carteira externa Fireblocks.

**Payload:**

| Campo        | Obrigatório | Descrição                      |
| ------------ | ----------- | ------------------------------ |
| `walletName` | Sim         | Nome do novo grupo de carteira |

**Response `200`:**

```json theme={null}
{ "walletId": "fb-wallet-abc123", "message": "External wallet created" }
```

Use o `walletId` retornado ao adicionar endereços a este grupo.

***

## Adicionar um endereço a um grupo

Forneça `walletId` e os detalhes do endereço para registrar um novo endereço em um grupo existente.

**Payload:**

| Campo          | Obrigatório | Descrição                                                   |
| -------------- | ----------- | ----------------------------------------------------------- |
| `walletName`   | Sim         | Nome do grupo existente                                     |
| `walletId`     | Sim         | ID do grupo de carteira Fireblocks (da resposta de criação) |
| `address`      | Sim         | Endereço cripto de destino                                  |
| `addressName`  | Sim         | Rótulo legível para este endereço                           |
| `currencyCode` | Sim         | Código do ativo (ex: `USDT_ETH`, `BTC`)                     |

**Response `200`:**

```json theme={null}
{ "message": "Whitelist request successful" }
```

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

  ```python Python (adicionar endereço) theme={null}
  import requests

  body, sig = sign_envelope({
      "walletName":   "Tesouraria",
      "walletId":     "fb-wallet-abc123",
      "address":      "0xABC123...",
      "addressName":  "Carteira quente",
      "currencyCode": "USDT_ETH",
  }, "a1b2c3d4-e5f6-4789-abcd-000000000001")
  response = requests.post(
      "https://checkout.noxpay.io/v2/naas/whitelist",
      headers={"api-key": "<key>", "X-Signature": sig, "Content-Type": "application/json"},
      data=body,
  )
  print(response.json())
  ```

  ```javascript Node.js (adicionar endereço) theme={null}
  const { body, signature } = signEnvelope({
    walletName:   "Tesouraria",
    walletId:     "fb-wallet-abc123",
    address:      "0xABC123...",
    addressName:  "Carteira quente",
    currencyCode: "USDT_ETH",
  }, "a1b2c3d4-e5f6-4789-abcd-000000000001");
  const response = await fetch("https://checkout.noxpay.io/v2/naas/whitelist", {
    method: "POST",
    headers: { "api-key": "<key>", "X-Signature": signature, "Content-Type": "application/json" },
    body,
  });
  const data = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 (criar grupo) theme={null}
  { "walletId": "fb-wallet-abc123", "message": "External wallet created" }
  ```

  ```json 200 (adicionar endereço) theme={null}
  { "message": "Whitelist request successful" }
  ```
</ResponseExample>
