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)

Remover chave PIX da subconta

DELETE
/api/subaccounts/{{subaccount_id}}/pix-keys/{{pix_key_id}}

Autenticação#

Esta rota exige Bearer Token (a API Key do master) no header. Envie EXATAMENTE assim:
A chave precisa do escopo subaccounts:write e a conta precisa da flag white-label habilitada. Sem a flag, a rota responde 404 (invisível).

Remover chave PIX da subconta#

Escopo: subaccounts:write
Remove uma chave PIX da subconta. O {{pix_key_id}} é o id retornado ao cadastrar/listar.

Regra de negócio#

Bloqueio por saque em uso: se houver saque em andamento usando esta chave (PENDING, PROCESSING ou NEEDS_REVIEW), a remoção é bloqueada com 422 PIX_KEY_IN_USE — a chave ainda pode liquidar ou exigir revisão manual e não pode sumir do registro.

Resposta#

200 OK com { success: true }.

Códigos de erro#

HTTPcodeQuando
401—Sem header Authorization ou chave inválida/revogada.
403insufficient_scopeChave sem o escopo subaccounts:write.
404—Flag white-label desabilitada, subconta inexistente/não pertence ao master, ou chave inexistente/não pertence à subconta.
422PIX_KEY_IN_USEHá saque em processamento usando esta chave.

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

🟠422
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff --request DELETE '/api/subaccounts/{{subaccount_id}}/pix-keys/{{pix_key_id}}' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso (200)
{
  "success": true
}
Modificado em 2026-07-02 06:57:27
Página anterior
Listar chaves PIX da subconta
Próxima página
Criar cobrança da subconta
Built with