1. Produtos e Links de Pagamento
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
          GET
        • Criar produto
          POST
        • Detalhe do produto
          GET
        • Carrinhos abandonados do produto
          GET
      • 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
      • 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. Produtos e Links de Pagamento

Criar produto

POST
/api/products

Autenticação#

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:
Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: products:write.
CampoTipoObrigatórioRegras
titlestringsim3–100 chars.
pricenumbersimEm REAIS, > 0, ≤ 100000.
slugstringsim3–50 chars, regex ^[a-z0-9-]+$. URL final: /checkout/{slug}.
descriptionstringnãoMáx 2000 chars.
imageUrlstringnãoURL HTTPS válida.
contentUrlstringnãoURL para entrega pós-pagamento.
isActivebooleannãoDefault true.
checkoutThemeenumnãoLIGHT
requireCustomerDatabooleannãoDefault true (exige nome+email+CPF).
sellerNamestringnãoOverride do nome no checkout.
acceptCardPaymentbooleannãoDefault false. Só é aceito true se o admin habilitou cartão para esta conta (User.cardPaymentEnabled); senão retorna 403. Cartão atualmente processado internamente pela plataforma.
A resposta inclui checkoutUrl — o link público do checkout do produto, pronto para compartilhar.
Cartão (opt-in por conta): por padrão nenhuma conta aceita cartão. Enviar acceptCardPayment: true sem o recurso habilitado na conta retorna 403 (Pagamento com cartão não está habilitado para esta conta). O cartão só aparece no checkout quando a conta está habilitada e o produto tem acceptCardPayment: true.

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

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/products' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "title": "Curso de Marketing Digital",
  "description": "Acesso vitalício, 40 horas de conteúdo.",
  "price": 297.00,
  "slug": "curso-marketing-digital",
  "isActive": true,
  "checkoutTheme": "DARK",
  "requireCustomerData": true,
  "contentUrl": "https://seu-dominio.com/area-do-aluno",
  "acceptCardPayment": false
}'
Response Response Example
{
  "id": "clprodNew",
  "userId": "cluser0001",
  "title": "Curso de Marketing Digital",
  "description": "Acesso vitalício, 40 horas de conteúdo.",
  "price": 29700,
  "imageUrl": null,
  "slug": "curso-marketing-digital",
  "checkoutUrl": "https://app.dotfy.com.br/checkout/curso-marketing-digital",
  "contentUrl": "https://seu-dominio.com/area-do-aluno",
  "isActive": true,
  "checkoutTheme": "DARK",
  "requireCustomerData": true,
  "sellerName": null,
  "acceptCardPayment": false,
  "type": "PRODUCT",
  "viewCount": 0,
  "orderCount": 0,
  "paidCount": 0,
  "totalRevenue": 0,
  "createdAt": "2026-05-07T10:30:00.000Z",
  "updatedAt": "2026-05-07T10:30:00.000Z"
}
Modificado em 2026-07-02 06:57:27
Página anterior
Listar produtos
Próxima página
Detalhe do produto
Built with