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)

Detalhe da subconta

GET
/api/subaccounts/{{subaccount_id}}

Autenticação#

Bearer Token = API Key do master. Escopo subaccounts:read. Sem a flag → 404.

Detalhe da subconta#

Escopo: subaccounts:read
Retorna o estado completo de uma subconta do master: dados cadastrais, balance, pixKeys, a última submissão de KYC (kycSubmission), as taxas efetivas da subconta (fees) e o piso de taxa herdado do master (feeBase).

Path param#

ParamDescrição
idID da subconta ({{subaccount_id}}).

Resposta#

200 OK com { subaccount: {...} }. Campos:
balance — available, reserved, pending em CENTAVOS.
pixKeys — lista com id, type, key, status, rejectionReason, createdAt.
kycSubmission — null ou { id, status, rejectionReason, createdAt, reviewedAt }.
fees — taxas efetivas da subconta (pixIn, withdrawal), cada uma com type, value (% ), fixed (em REAIS).
feeBase — piso de taxa herdado do master, mesmo formato de fees.
deletedAt — null enquanto ativa.
Sigilo (CRÍTICO): fees é a taxa cheia cobrada da subconta e feeBase é o piso operacional. Em NENHUM lugar deste retorno aparece a comissão do master nem a decomposição da taxa — isso é assunto exclusivo do extrato do master.

Erros#

HTTPQuando
401API key ausente/inválida.
403Escopo subaccounts:read ausente.
404Sem a flag, subconta inexistente, de outro master, ou soft-deletada (anti-IDOR — nunca revela existência).

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}}' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso (200)
{
  "subaccount": {
    "id": "{{subaccount_id}}",
    "correlationId": "seller-001",
    "name": "Loja do João LTDA",
    "email": "financeiro@lojadojoao.com.br",
    "taxId": "12345678000199",
    "taxIdType": "CNPJ",
    "phone": "11999998888",
    "kycStatus": "PRE_APPROVED",
    "kycSubmission": null,
    "fees": {
      "pixIn": {
        "type": "PERCENT",
        "value": 1.99,
        "fixed": null
      },
      "withdrawal": {
        "type": "FIXED",
        "value": null,
        "fixed": 3.5
      }
    },
    "feeBase": {
      "pixIn": {
        "type": "PERCENT",
        "value": 1.99,
        "fixed": null
      },
      "withdrawal": {
        "type": "FIXED",
        "value": null,
        "fixed": 3.5
      }
    },
    "balance": {
      "available": 125000,
      "reserved": 0,
      "pending": 0
    },
    "pixKeys": [
      {
        "id": "{{pix_key_id}}",
        "type": "CNPJ",
        "key": "12345678000199",
        "status": "APPROVED",
        "rejectionReason": null,
        "createdAt": "2026-06-12T14:35:00.000Z"
      }
    ],
    "deletedAt": null,
    "createdAt": "2026-06-12T14:30:00.000Z"
  }
}
Modificado em 2026-07-02 06:57:27
Página anterior
Listar subcontas
Próxima página
Atualizar subconta
Built with