Link de Pagamento

O Link de Pagamento permite criar uma cobrança e compartilhar um link com o cliente — sem integração de checkout no seu site. Ideal para vendas por WhatsApp, e-mail ou redes sociais.

[!WARNING] Links de pagamento estão disponíveis apenas em produção. Não é possível testá-los no ambiente Sandbox.

Crie o link com os produtos e configurações

Defina os produtos, meios de pagamento aceitos, parcelamento, dados do cliente e personalização visual.

Compartilhe o link com o cliente

A API retorna uma URL que o cliente acessa para realizar o pagamento.

Monitore o pagamento via webhook

Configure `transaction.paid` para ser notificado quando o pagamento for confirmado.

Edite ou desative o link conforme necessário

Atualize título, descrição, limite de transações ou ative/desative o link a qualquer momento.

Passo 1 — Criar o link

curl --request POST \
  --url "{apiUrl}/set-payment-link" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Curso de Programação",
    "description": "Acesso completo ao curso por 12 meses",
    "limit": 100,
    "expireAt": "2026-12-31",
    "products": [
      {
        "name": "Curso de Programação",
        "price": 49700,
        "min": 1,
        "max": 1
      }
    ],
    "paymentConfig": {
      "pix": true,
      "credit": true,
      "boleto": false,
      "max_installments": 12
    }
  }'

Configurações disponíveis

Opção	Descrição
Produtos (`products`)	Lista de itens com nome, preço em centavos e quantidade min/max
Parcelamento (`max_installments`)	Número máximo de parcelas no cartão de crédito
Meios de pagamento (`pix`, `credit`, `boleto`)	Quais métodos o cliente pode usar
Limite (`limit`)	Número máximo de transações (0 = ilimitado)
Expiração (`expireAt`)	Data após a qual o link é desativado automaticamente

Passo 2 — Editar o link

curl --request PUT \
  --url "{apiUrl}/edit-payment-link/{id}" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Curso de Programação — Oferta Especial",
    "description": "Desconto por tempo limitado",
    "actived": true,
    "limit": 50
  }'

Passo 3 — Consultar o link

curl --request GET \
  --url "{apiUrl}/payment-link/{id}" \
  --header "Authorization: Bearer {token}"

Próximos passos

Configurando Webhooks — receba notificações de pagamento
Link de Pagamento — referência completa da API