1. Nominais
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças (PIX & Boleto)
        • Criar cobrança PIX
        • Criar boleto
        • Listar cobranças
        • Consultar cobrança por correlationID
        • Histórico de webhooks de uma cobrança
      • Cartão (Checkout Transparente)
        • Criar pagamento com cartão (PAN via API)
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
        • Detalhe de um cliente
      • Produtos e Links de Pagamento
        • Links de compra por comprador (Purchase Links)
          • Criar link de compra (por comprador)
          • Listar links de compra do produto
          • Detalhe/status do link de compra
          • Revogar link de compra
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Subcontas White-Label (BaaS)
        • Criar subconta
        • Listar subcontas
        • Detalhe da subconta
        • Atualizar subconta
        • Excluir subconta (soft delete)
        • Enviar KYC da subconta (multipart)
        • Consultar status do KYC da subconta
        • Cadastrar chave PIX da subconta
        • Listar chaves PIX da subconta
        • Remover chave PIX da subconta
        • Criar cobrança da subconta
        • Listar cobranças da subconta
        • Detalhe de cobrança da subconta
        • Saldo da subconta
        • Extrato (transações) da subconta
        • Solicitar saque da subconta
        • Listar saques da subconta
        • Atualizar taxas da subconta
      • Nominais
        • Listar nominais disponíveis
          GET
        • Trocar de nominal
          POST
        • Definir nominal de fallback
          PATCH
        • Estado da troca em andamento
          GET
        • [Admin] Catálogo completo de nominais
          GET
        • [Admin] Criar nominal
          POST
        • [Admin] Editar nominal
          PATCH
        • [Admin] Desabilitar nominal (soft)
          DELETE
        • [Admin] Acesso e taxas por usuário
          PATCH
        • Nominais permitidas à subconta
          GET
        • Trocar nominal da subconta (master)
          PATCH
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
        • Criar endpoint
        • Atualizar endpoint
        • Remover endpoint
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
        • EVENT:CHARGE_PAID — boleto pago
        • EVENT:CHARGE_EXPIRED — cobrança expirada
        • EVENT:SPLIT_RECEIVED — você recebeu um split
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
        • EVENT:DISPUTE_WON — disputa ganha
        • EVENT:DISPUTE_LOST — disputa perdida
        • EVENT:DISPUTE_CANCELED — disputa cancelada
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
        • EVENT:WITHDRAWAL_FAILED — saque falhou
        • EVENT:SUBACCOUNT_KYC_APPROVED — KYC da subconta aprovado
        • EVENT:SUBACCOUNT_KYC_REJECTED — KYC da subconta recusado
        • EVENT:SUBACCOUNT_PIX_KEY_APPROVED — chave PIX da subconta aprovada
        • EVENT:SUBACCOUNT_PIX_KEY_REJECTED — chave PIX da subconta recusada
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Nominais

[Admin] Acesso e taxas por usuário

PATCH
/api/admin/nominais/access

Autenticação#

Requer papel ADMIN. Authorization: Bearer {{admin_api_key}}.

[Admin] Habilitar/desabilitar nominal + override de taxa por usuário#

Cria ou atualiza (upsert) a relação usuário × nominal: libera/bloqueia uma nominal para um usuário específico e, opcionalmente, define taxas especiais que sobrescrevem as taxas-base do catálogo só para aquele usuário.

Body#

CampoTipoObrigatórioDescrição
userIdstringsimId do usuário-alvo.
nominalIdstringsimId da nominal.
accessenumnãoENABLED (libera) | DISABLED (bloqueia). Default no upsert de criação: ENABLED.
feePixIn, feePixInType, feePixInFixednumber/enumnãoOverride da taxa de entrada para este usuário.
feeWithdrawal, feeWithdrawalType, feeWithdrawalFixednumber/enumnãoOverride da taxa de saque para este usuário.
As taxas omitidas mantêm o valor anterior (ou herdam o catálogo). type: PERCENT | FIXED | PERCENT_PLUS_FIXED.

Resposta#

200 OK com { userNominal: { ... } }.

Erros#

HTTPQuando
400Body inválido (Zod).
401 / 403Sem credencial ADMIN.
404Usuário ou nominal não encontrado.

Exemplo cURL#

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/api/admin/nominais/access' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "userId": "{{user_id}}",
  "nominalId": "{{nominal_id}}",
  "access": "ENABLED",
  "feePixIn": 1.99,
  "feeWithdrawal": 0.99
}'
Response Response Example
200 - Sucesso (200)
{
  "userNominal": {
    "id": "un_123",
    "userId": "{{user_id}}",
    "nominalId": "{{nominal_id}}",
    "access": "ENABLED",
    "feePixIn": 1.99,
    "feeWithdrawal": 0.99
  }
}
Modificado em 2026-07-14 04:02:21
Página anterior
[Admin] Desabilitar nominal (soft)
Próxima página
Nominais permitidas à subconta
Built with