1. Subcontas White-Label (BaaS)
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças PIX
        • Criar cobrança PIX
        • 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
          POST
        • Listar subcontas
          GET
        • Detalhe da subconta
          GET
        • Atualizar subconta
          PATCH
        • Excluir subconta (soft delete)
          DELETE
        • Enviar KYC da subconta (multipart)
          POST
        • Consultar status do KYC da subconta
          GET
        • Cadastrar chave PIX da subconta
          POST
        • Listar chaves PIX da subconta
          GET
        • Remover chave PIX da subconta
          DELETE
        • Criar cobrança da subconta
          POST
        • Listar cobranças da subconta
          GET
        • Detalhe de cobrança da subconta
          GET
        • Saldo da subconta
          GET
        • Extrato (transações) da subconta
          GET
        • Solicitar saque da subconta
          POST
        • Listar saques da subconta
          GET
        • Atualizar taxas da subconta
          PUT
      • 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_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. Subcontas White-Label (BaaS)

Atualizar taxas da subconta

PUT
/api/subaccounts/{{subaccount_id}}/fees

Operação delegada (white-label)#

Define as taxas que a subconta paga (PIX-in e/ou saque). É assim que o master repassa um markup para suas subcontas. Autenticada pela API Key do master.
Escopo: subaccounts:write

Body — envie ao menos um componente#

Cada componente (pixIn, withdrawal) tem o mesmo formato:
CampoTipoDescrição
typeenumPERCENT | FIXED | PERCENT_PLUS_FIXED.
valuenumber|nullParcela percentual em % (0–100). Em FIXED, este campo é a parcela fixa em REAIS (0–1000).
fixednumber|nullParcela fixa em REAIS (0–1000). Usado em PERCENT_PLUS_FIXED.
Interpretação por type (espelha o normalizador do servidor):
PERCENT → usa apenas value (%); fixed ignorado.
FIXED → usa apenas value (reais); fixed ignorado.
PERCENT_PLUS_FIXED → value (%) + fixed (reais).

Regra de negócio (crítica) — FEE_BELOW_BASE#

A taxa de cada componente da subconta não pode ser menor que a taxa base do master (nem no percentual, nem na parcela fixa). Se violar, retorna 422 com code: "FEE_BELOW_BASE" e a base do master no corpo, por componente (PIX-in e saque são validados independentemente).

Resposta 200 OK#

{ success: true, fees: { pixIn?, withdrawal? } } — ecoa os componentes aplicados (valores como enviados: % e reais).

Códigos de erro#

HTTPcodeQuando
400—Body inválido (Zod): nenhum componente, type fora do enum, fora dos ranges.
401—API Key ausente/inválida.
404—Master sem white-label, ou subconta inexistente/não-sua.
422FEE_BELOW_BASETaxa abaixo da base do master (PIX-in ou saque).

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

🟠422
🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff --request PUT '/api/subaccounts/{{subaccount_id}}/fees' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "pixIn": {
    "type": "PERCENT_PLUS_FIXED",
    "value": 2.5,
    "fixed": 0.50
  },
  "withdrawal": {
    "type": "FIXED",
    "value": 5.00,
    "fixed": null
  }
}'
Response Response Example
200 - Sucesso (200) — taxas aplicadas
{
  "success": true,
  "fees": {
    "pixIn": { "type": "PERCENT_PLUS_FIXED", "value": 2.5, "fixed": 0.5 },
    "withdrawal": { "type": "FIXED", "value": 5, "fixed": null }
  }
}
Modificado em 2026-07-02 06:57:27
Página anterior
Listar saques da subconta
Próxima página
Webhooks (Gerenciar Endpoints)
Built with