---
updatedAt: 2026-04-27T12:53:04.000Z
agentTools:
  projectIndex: https://developers.vindi.com.br/llms.txt
---

# Assinatura - Link de Pagamento - Boleto Vindi

<Image align="center" src="https://files.readme.io/ebf5b61-Fluxo_Assinatura_-_Link_de_Pagamento_Boleto_Vindi.png" />

<br />

### Título do Fluxo: Fluxo Assinatura - Link de Pagamento (Boleto Vindi)

Este diagrama mostra o processo de geração e pagamento de uma assinatura utilizando o método de pagamento Boleto Vindi na plataforma Vindi. Abaixo está a descrição detalhada de cada passo no fluxo, incluindo métodos de autenticação, endpoints e exemplos de parâmetros para requisições.

#### 1. Contratar o Serviço

**Descrição:** O cliente contrata o serviço que requer a criação de uma assinatura.

#### 2. Cadastrar o Cliente

**Método:** POST\
**Endpoint:** `/v1/customers`\
**Descrição:** Cadastra o cliente na plataforma Vindi.\
**Exemplo de Parâmetros:**

```json
{
  "name": "Nome do Cliente",
  "email": "emaildocliente@teste.com",
  "registry_code": "430.967.348-10",
  "address": {
    "street": "R. do Paraíso",
    "number": "148",
    "zipcode": "04103-000",
    "neighborhood": "Liberdade",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "phones": [
    {
      "phone_type": "mobile",
      "number": "5511991468778"
    }
  ]
}
```

#### 3. Criar Assinatura

**Método:** POST\
**Endpoint:** `/v1/subscriptions`\
**Descrição:** Cria uma assinatura para o cliente cadastrado.\
**Exemplo de Parâmetros:**

```json
{
  "plan_id": 12345,
  "customer_id": 873101,
  "payment_method_code": "bank_slip",
  "subscription_items": [
    {
      "product_id": 88171,
      "amount": 150,
      "description": "Teste Vindi assinatura R$5,90"
    }
  ]
}
```

### Ciclo da Assinatura

#### Gera o Ciclo da Assinatura

**Descrição:** A cada ciclo da assinatura, a Vindi gera a fatura correspondente e registra o boleto no banco.

#### Enviar Link de Pagamento

**Descrição:** O sistema envia ao cliente um link de pagamento contendo o boleto para que ele possa realizar o pagamento da fatura.

#### Pagamento Aprovado

**Descrição:** Quando o pagamento é identificado como aprovado, a Vindi processa o arquivo e atualiza as cobranças, realizando a baixa na fatura.\
**Endpoint Webhook:** `Fatura Paga`\
**Notas:** A Vindi envia um webhook "Fatura Paga" para notificar que o pagamento foi realizado com sucesso.

#### Pagamento Não Identificado

**Descrição:** Se o pagamento não for identificado, a Vindi pode enviar uma notificação informando que o pagamento não foi identificado.\
**Notas:** Na notificação enviada pela Vindi, o link da fatura está disponível para que o cliente possa pagar através de outro método de pagamento.

### Resumo das Requisições:

1. **Cadastrar Cliente:**
   * **Método:** POST
   * **Endpoint:** `/v1/customers`
   * **Exemplo de Parâmetros:**
     ```json
     {
       "name": "Nome do Cliente",
       "email": "emaildocliente@teste.com",
       "registry_code": "430.967.348-10",
       "address": {
         "street": "R. do Paraíso",
         "number": "148",
         "zipcode": "04103-000",
         "neighborhood": "Liberdade",
         "city": "São Paulo",
         "state": "SP",
         "country": "BR"
       },
       "phones": [
         {
           "phone_type": "mobile",
           "number": "5511991468778"
         }
       ]
     }
     ```

2. **Criar Assinatura:**
   * **Método:** POST
   * **Endpoint:** `/v1/subscriptions`
   * **Exemplo de Parâmetros:**
     ```json
     {
       "plan_id": 12345,
       "customer_id": 873101,
       "payment_method_code": "bank_slip",
       "subscription_items": [
         {
           "product_id": 88171,
           "amount": 150,
           "description": "Teste Vindi assinatura R$5,90"
         }
       ]
     }
     ```

### Notas Adicionais:

* **Webhook "Fatura Emitida":** Usado para notificar a emissão da fatura.
* **Webhook "Fatura Paga":** Usado para notificar que a fatura foi paga com sucesso.
* **Notificação de Pagamento:** Se o pagamento não for identificado, o cliente é notificado com opções para tentar novamente com outro método de pagamento.

Estas descrições ajudam a entender como realizar a atividade de emissão e pagamento de assinaturas via Boleto Vindi, conforme ilustrado no diagrama.