Links de Pagamento

Crie e gerencie links de pagamento para cobranças recorrentes

Endpoints

GET /api/payment-links

Lista todos os links de pagamento cadastrados.

Parâmetros de Query
{
  "active": boolean,         // Filtra por status (opcional)
  "offset": number,          // Registros a pular (opcional, padrão: 0)
  "limit": number           // Máximo de registros (opcional, padrão: 10)
}
Resposta
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "value": number,
    "billingType": "string",
    "dueDateLimitDays": number,
    "subscriptionCycle": "string",
    "maxInstallmentCount": number,
    "endDate": "string",
    "url": "string",
    "isActive": boolean,
    "asaasId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]

POST /api/payment-links

Cria um novo link de pagamento.

Request Body
{
  "name": "string",                    // Nome do link
  "description": "string",            // Descrição do link
  "value": number,                    // Valor do pagamento
  "billingType": "string",           // Tipo de cobrança (BOLETO, CREDIT_CARD, PIX)
  "dueDateLimitDays": number,        // Dias para vencimento (opcional)
  "subscriptionCycle": "string",     // Ciclo da assinatura (WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY)
  "maxInstallmentCount": number,     // Máximo de parcelas (opcional)
  "endDate": "string",               // Data de término (opcional, YYYY-MM-DD)
  "isActive": boolean               // Status do link (opcional, padrão: true)
}
Exemplo
curl -X POST "http://seu-servidor/api/payment-links" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Assinatura Premium",
    "description": "Acesso ao plano premium mensal",
    "value": 99.90,
    "billingType": "CREDIT_CARD",
    "dueDateLimitDays": 5,
    "subscriptionCycle": "MONTHLY",
    "maxInstallmentCount": 12,
    "endDate": "2024-12-31",
    "isActive": true
  }'

GET /api/payment-links/:id

Obtém detalhes de um link de pagamento específico.

Exemplo
curl -X GET "http://seu-servidor/api/payment-links/123"

PATCH /api/payment-links/:id

Atualiza um link de pagamento existente.

Request Body
{
  "name": "string",                    // Opcional
  "description": "string",            // Opcional
  "value": number,                    // Opcional
  "billingType": "string",           // Opcional
  "dueDateLimitDays": number,        // Opcional
  "subscriptionCycle": "string",     // Opcional
  "maxInstallmentCount": number,     // Opcional
  "endDate": "string",               // Opcional
  "isActive": boolean               // Opcional
}
Exemplo
curl -X PATCH "http://seu-servidor/api/payment-links/123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Assinatura Premium Plus",
    "value": 149.90,
    "maxInstallmentCount": 6
  }'

DELETE /api/payment-links/:id

Remove um link de pagamento.

Exemplo
curl -X DELETE "http://seu-servidor/api/payment-links/123"
Ciclos de Assinatura
  • WEEKLY: Semanal
  • BIWEEKLY: Quinzenal
  • MONTHLY: Mensal
  • QUARTERLY: Trimestral
  • SEMIANNUALLY: Semestral
  • YEARLY: Anual
Tipos de Cobrança
  • BOLETO: Gera um boleto bancário
  • CREDIT_CARD: Cobrança via cartão de crédito
  • PIX: Gera um QR Code PIX
Boas Práticas
  • Use nomes e descrições claras para identificar o propósito do link
  • Configure um ciclo de assinatura adequado ao seu negócio
  • Defina uma data de término para links temporários
  • Monitore o uso dos links através do campo isActive
  • Mantenha os valores e condições atualizados