Skip to main content
O caso mais comum: cobrar um valor específico via PIX.
curl -X POST https://api.pagozz.com/v1/links \
  -H "Content-Type: application/json" \
  -H "Pagozz-Token: pgz_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -d '{
    "name": "Consultoria 1h",
    "amount": 15000,
    "value_mode": "fixed",
    "payment_methods": ["pix"]
  }'
Deixe o pagador escolher quanto pagar (doações, gorjetas, etc.):
const link = await pagozz.links.create({
  name: 'Doação',
  value_mode: 'free',
  payment_methods: ['pix'],
});
Defina um piso e deixe o pagador pagar mais:
const link = await pagozz.links.create({
  name: 'Contribuição',
  min_amount: 5000, // R$ 50,00 mínimo
  value_mode: 'minimum',
  payment_methods: ['pix'],
});

Com vencimento e penalidades

Configure desconto por antecipação, multa e juros por atraso:
const link = await pagozz.links.create({
  name: 'Mensalidade Março',
  amount: 50000, // R$ 500,00
  value_mode: 'fixed',
  payment_methods: ['pix'],
  due_date: '2026-03-15',
  early_discount_type: 'percentage',
  early_discount_value: 500, // 5%
  early_discount_until: '2026-03-10',
  late_penalty_type: 'percentage',
  late_penalty_value: 200, // 2%
  daily_interest_type: 'percentage',
  daily_interest_value: 10, // 0,1%/dia
});

Campos do checkout customizados

Exija ou oculte campos no formulário do pagador:
const link = await pagozz.links.create({
  name: 'Produto Premium',
  amount: 29900,
  value_mode: 'fixed',
  payment_methods: ['pix'],
  checkout_fields: {
    full_name: 'required',
    phone: 'required',
    address: 'optional',
    company_name: 'disabled',
    cnpj: 'disabled',
  },
});

Redirect pós-pagamento

Redirecione o pagador após o pagamento ou exiba um botão de retorno:
const link = await pagozz.links.create({
  name: 'Curso Online',
  amount: 19900,
  value_mode: 'fixed',
  payment_methods: ['pix'],
  success_redirect_url: 'https://meusite.com/obrigado',
  callback_url: 'https://meusite.com/loja',
});
CampoComportamento
success_redirect_urlRedirect automático após confirmação
callback_urlBotão “Voltar à loja” no checkout
// Listar links
const { links, total } = await pagozz.links.list({
  status: 'active',
  page: 1,
  page_size: 20,
});

// Atualizar
await pagozz.links.update('link-id', { name: 'Novo nome' });

// Desativar (soft delete)
await pagozz.links.delete('link-id');