Skip to main content

​
Visão geral

Use este endpoint para cadastrar um novo produto no seu catálogo. Produtos podem ser referenciados na criação de links de pagamento e assinaturas, simplificando a geração de cobranças recorrentes ou avulsas.

​
Endpoint

curl -X POST https://api.avanttifinance.com/v1/products \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Plano Mensal Premium",
    "description": "Acesso completo à plataforma por 30 dias",
    "price": 9990,
    "currency": "BRL"
  }'

​
Parâmetros do corpo

​
name
string
required
Nome do produto, exibido em links de pagamento e faturas.
​
description
string
Descrição detalhada do produto.
​
price
integer
required
Preço do produto em centavos (ex: 9990 representa R$ 99,90).
​
currency
string
required
Código da moeda no formato ISO 4217. Atualmente, apenas BRL é suportado.
​
metadata
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o produto.

​
Resposta

​
id
string
Identificador único do produto, no formato prod_xxxxxxxxxxxx.
​
name
string
Nome do produto.
​
description
string
Descrição do produto.
​
price
integer
Preço do produto em centavos.
​
currency
string
Código da moeda do produto.
​
created_at
string
Data e hora de criação do produto, no formato ISO 8601.

​
Exemplo de resposta

{
  "id": "prod_8f72a1b3c4d5",
  "name": "Plano Mensal Premium",
  "description": "Acesso completo à plataforma por 30 dias",
  "price": 9990,
  "currency": "BRL",
  "metadata": {},
  "created_at": "2025-01-15T10:30:00Z"
}
Utilize o campo metadata para armazenar identificadores internos do seu sistema e facilitar a conciliação posterior.

​
Erros comuns

Código HTTPSignificado
400Dados inválidos ou campos obrigatórios ausentes
401Token de autenticação inválido ou ausente
422Valor de price ou currency inválido

​
Próximos passos

Listar produtos

Consulte todos os produtos cadastrados.

Editar produto

Atualize os dados de um produto existente.