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

Nominais permitidas à subconta

GET
/api/subaccounts/{{subaccount_id}}/nominal

Autenticação#

Bearer Token = API Key do master white-label (flag whiteLabelEnabled + escopo subaccounts:read). Sem a flag → 404 (rota invisível).

Nominais permitidas à subconta#

Lista as nominais visíveis para a subconta indicada, no mesmo formato do catálogo do usuário (slug, displayName, isPremium, usable, feePixIn, feeWithdrawal, isCurrent, isFallback). Quem consulta e opera é sempre o master, via /api/subaccounts/{id}/nominal.

Path#

ParamDescrição
{{subaccount_id}}Id da subconta.

Resposta#

200 OK com { data: NominalItem[] }.

Erros#

HTTPQuando
401 / 403API key ausente / escopo insuficiente.
404Sem a flag whiteLabelEnabled, ou subconta inexistente/não pertencente ao master.

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

Respostas

🟢200
application/json
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/nominal' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso (200)
{
  "data": [
    {
      "slug": "padrao",
      "displayName": "Padrão",
      "isPremium": false,
      "usable": true,
      "feePixIn": 2.99,
      "feeWithdrawal": 1.99,
      "isCurrent": true,
      "isFallback": false
    },
    {
      "slug": "hub",
      "displayName": "Hub",
      "isPremium": true,
      "usable": true,
      "feePixIn": 2.49,
      "feeWithdrawal": 1.49,
      "isCurrent": false,
      "isFallback": false
    }
  ]
}
Modificado em 2026-07-14 04:02:21
Página anterior
[Admin] Acesso e taxas por usuário
Próxima página
Trocar nominal da subconta (master)
Built with