Skip to main content
POST
Criar Produto

Visão Geral

O endpoint de criação de produtos permite que você crie produtos para vendas avulsas (one-time purchases) ou assinaturas (recurring billing). Cada produto criado recebe um uuid único que é usado para gerar o link de pagamento.

Requisição

Campos Obrigatórios

string
required
Nome do produto. Será exibido na página de pagamento.
string
required
URL da imagem do produto.
number
required
Preço do produto em Reais (BRL decimal, ex: 297.00), nunca em centavos.
  • 0 cria um produto sem preço. É aceito, mas o produto não vende pelo link de pagamento: a cobrança de R$ 0,00 é recusada. Use para um produto que você cobra de outro jeito, como por cobranças agendadas.
  • Qualquer outro preço precisa ser de **pelo menos R5,00∗∗,oprec\comıˊnimodaplataforma.DeR 5,00**, o preço mínimo da plataforma. De R 0,01 a R$ 4,99, ou um valor negativo, a API responde 400.
  • Em um produto de assinatura (isSubscription: true), o preço fica nos preços de assinatura e este campo não é verificado. Envie 0.

Campos Opcionais

string
default:""
Descrição do produto. Ajuda o cliente a entender o que está comprando.
boolean
default:"false"
Habilita pagamento via PIX.
boolean
default:"false"
Habilita pagamento via cartão de crédito.
boolean
default:"false"
Habilita pagamento via boleto bancário.
boolean
default:"true"
Habilita o Pix Automático (débito recorrente do Pix) no checkout de assinatura do produto. Vem ligado por padrão — envie false para não oferecer. Produtos que não são assinatura ignoram o campo.
number
default:"1"
Número máximo de parcelas permitidas (1-12).
string[]
Tags para categorizar o produto.
string
URL para redirecionar o cliente após o pagamento.
string
Texto do botão de redirecionamento (máximo 100 caracteres).
string
ID do Facebook Pixel para rastreamento.
boolean
default:"false"
Define se o produto é de assinatura (cobrança recorrente). Para produtos de assinatura, o preço é definido nos preços de assinatura, não no campo value.
name, image e value são obrigatórios. Os métodos de pagamento vêm desligados por padrão: envie pix, creditCard e boleto com true para os que você quer aceitar.

Exemplo de Requisição

Exemplo Mínimo

Crie um produto à venda com os campos obrigatórios e o PIX ligado:

Exemplo Completo

Personalize todas as opções do produto:

Exemplo para Assinatura

Para produtos com cobrança recorrente, defina isSubscription: true e envie value: 0. O preço será configurado depois, nos preços de assinatura, que também seguem o mínimo de R$ 5,00:
Após criar um produto de assinatura, você precisa criar preços de assinatura para definir os planos (mensal, anual, etc.) e seus valores.

Resposta de Sucesso

string
Identificador único usado para o link de pagamento.
string
Nome do produto.
string
Descrição do produto.
number
Preço do produto em Reais. 0 indica um produto sem preço.
boolean
Se PIX está habilitado.
boolean
Se cartão de crédito está habilitado.
boolean
Se boleto está habilitado.
boolean
Se o Pix Automático (débito recorrente) está habilitado.
array
Lista de parcelas com valores calculados.
boolean
Status do produto.
boolean
Se o produto é de assinatura (cobrança recorrente).
string
Data de criação (ISO 8601).
string
Data da última atualização (ISO 8601).

Exemplo de Resposta (201 Created)

Erros Comuns

Solução: Envie um value de pelo menos 5.00, ou 0 para um produto sem preço. De R0,01aR 0,01 a R 4,99 o produto é recusado, e um valor negativo também.
Solução: name, image e value são obrigatórios. A mensagem de erro indica qual campo faltou.
Solução: Verifique se o header Authorization está correto.

Próximos Passos

Link de Pagamento

Aprenda a usar e compartilhar o link de pagamento

Listar Produtos

Consulte seus produtos existentes

Criar Preço de Assinatura

Configure planos de preço para produtos de assinatura

Guia de Assinaturas

Aprenda a configurar cobrança recorrente