ChaveMe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/luniumpay-com/json-schema/luniumpay-com-chave-me-schema.json",
  "title": "ChaveMe",
  "description": "Sua chave, limites vigentes e o que está liberado.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/luniumpay-com-openapi.json#/components/schemas/ChaveMe",
  "type": "object",
  "properties": {
    "key": {
      "type": "object",
      "properties": {
        "sandbox": {
          "type": "boolean"
        },
        "key_id": {
          "type": "integer"
        },
        "prefix": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "E-mail informado na criação da chave. Chave de teste exige e-mail desde 01/10/2026; null em chave antiga criada sem e-mail."
        },
        "cashin_enabled": {
          "type": "boolean"
        },
        "cashout_enabled": {
          "type": "boolean"
        },
        "payout_enabled": {
          "type": "boolean"
        },
        "settlement_address": {
          "type": [
            "string",
            "null"
          ],
          "description": "Carteira padrão de liquidação (Polygon); null até ser configurada."
        },
        "chain": {
          "type": [
            "string",
            "null"
          ]
        },
        "fee_bps": {
          "type": "integer"
        },
        "rate_limit_per_minute": {
          "type": "integer"
        },
        "webhook_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "null até cadastrar (PATCH /keys/me) — sem ela não chega cashin.paid/settled/delayed."
        },
        "webhook_configured": {
          "type": "boolean"
        },
        "telegram_linked": {
          "type": "boolean"
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "partner_fee_bps": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000,
          "description": "SUB FEE do parceiro, em bps, POR CIMA de `fee_bps` (a taxa da Lunium). 100 = 1%. Quem paga é o usuário final; a parte da Lunium não muda. 0 = não usa. Configure em PATCH /keys/me."
        },
        "partner_cashout_fee_bps": {
          "type": "integer",
          "description": "Sub fee do parceiro na venda (bps). 0 = nao usa."
        },
        "partner_saque_fee_bps": {
          "type": "integer",
          "description": "Sub fee do parceiro na saida da custodia (bps). 0 = nao usa."
        },
        "partner_deposito_fee_bps": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000,
          "default": 0,
          "description": "Subfee exclusiva do depósito Pix em saldo BRL, em basis points (100 = 1%). Padrão 0, máximo 1000. Aplicada ao valor recebido após a taxa fixa Lunium, descontada antes do crédito no saldo. Independente de compra, venda e saque. Congelada na criação; comissão creditada somente após liberação e crédito concluído (paid/sent)."
        }
      }
    },
    "nivel_conta": {
      "type": [
        "object",
        "null"
      ],
      "description": "Nível comercial da conta e os benefícios que valem HOJE para esta chave. `padrao`: escada por pagador e retenção automática (veja limits.payer_limits). `vip_master`: toda a entrada Pix até o teto por cobrança, sem retenção, sem a taxa fixa por Pix, sem escada por pagador e com CPF/CNPJ do pagador opcional. Leitura de decisão já registrada; quem decide na cobrança continua sendo a rota. null quando a leitura falha.",
      "properties": {
        "nivel": {
          "type": "string",
          "enum": [
            "padrao",
            "vip_master"
          ]
        },
        "rotulo": {
          "type": "string"
        },
        "desde": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "beneficios": {
          "type": "object",
          "properties": {
            "teto_por_cobranca_cents": {
              "type": [
                "integer",
                "null"
              ]
            },
            "retencao_horas": {
              "type": [
                "integer",
                "null"
              ]
            },
            "taxa_fixa_pix_cents": {
              "type": "integer"
            },
            "taxa_fixa_pix_padrao_cents": {
              "type": "integer"
            },
            "documento_pagador": {
              "type": "string",
              "enum": [
                "obrigatorio",
                "opcional"
              ]
            },
            "escada_por_pagador": {
              "type": "boolean"
            }
          }
        },
        "nota": {
          "type": "string"
        }
      }
    },
    "limits": {
      "type": "object",
      "description": "Limites e uso vigentes da chave, por operação e pagador. null em teto diário significa ausência daquele teto, não de todas as restrições. Mandate e limites por pessoa podem aplicar.",
      "additionalProperties": true,
      "properties": {
        "cashin_min_por_rota": {
          "type": "object",
          "description": "Minimo em reais por moeda e rede, ja com as taxas desta chave. O min_brl_cents do cash-in em per_operation e o piso da CONTA (o que a taxa fixa exige); o piso da REDE e maior e e ele que costuma recusar. Vale o maior dos dois.",
          "properties": {
            "nota": {
              "type": "string"
            },
            "rotas": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "asset": {
                    "type": "string"
                  },
                  "network": {
                    "type": "string"
                  },
                  "min_brl_cents": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    "payout": {
      "type": "object",
      "description": "enabled, via, unlocks_at_settled_volume_cents, settled_volume_cents, remaining_cents.",
      "additionalProperties": true
    },
    "monitor_url": {
      "type": "string",
      "description": "Painel de acompanhamento da chave."
    },
    "telegram": {
      "type": "object",
      "additionalProperties": true
    },
    "grupos_obrigatorios": {
      "type": "object",
      "description": "Links dos grupos de status (aviso, parceiros, comunidade).",
      "additionalProperties": true
    },
    "comissao": {
      "type": "object",
      "description": "Comissão acumulada pela sub fee (saldo do parceiro). Detalhe em GET /comissao.",
      "properties": {
        "partner_fee_bps": {
          "type": "integer"
        },
        "max_partner_fee_bps": {
          "type": "integer"
        },
        "disponivel_cents": {
          "type": [
            "integer",
            "null"
          ]
        },
        "creditado_cents": {
          "type": "integer"
        },
        "estornado_cents": {
          "type": "integer"
        },
        "sacado_cents": {
          "type": "integer"
        },
        "operacoes": {
          "type": "integer"
        },
        "ultimo_credito_em": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "moeda": {
          "type": "string"
        },
        "nota": {
          "type": "string"
        },
        "partner_cashout_fee_bps": {
          "type": "integer"
        },
        "partner_saque_fee_bps": {
          "type": "integer"
        },
        "partner_deposito_fee_bps": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000,
          "default": 0,
          "description": "Subfee exclusiva do depósito Pix em saldo BRL, em basis points (100 = 1%). Padrão 0, máximo 1000. Aplicada ao valor recebido após a taxa fixa Lunium, descontada antes do crédito no saldo. Independente de compra, venda e saque. Congelada na criação; comissão creditada somente após liberação e crédito concluído (paid/sent)."
        }
      }
    }
  }
}