Assinatura - Checkout Transparente - Boleto Bancário com Van

Título do Fluxo: Assinatura - Boleto Bancário VAN

Este diagrama mostra o processo de geração e pagamento de uma assinatura utilizando o método de pagamento Boleto Bancário através de uma VAN (Value Added Network) 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. Acessar a Plataforma e Checkout

Descrição: O cliente acessa a plataforma para realizar o checkout e iniciar o processo de pagamento.

2. Cadastrar o Cliente

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

{
  "name": "Nome do Cliente",
  "email": "[email protected]",
  "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, informa "bank_slip" no "payment_method_code" e gera a fatura.
Exemplo de Parâmetros:

{
  "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"
    }
  ]
}

Geração de Arquivo de Remessa

Gerar Arquivo de Remessa

Método: POST
Endpoint: /v1/export_batches
Descrição: Gera o arquivo de remessa contendo os boletos.
Exemplo de Parâmetros:

{
  "batches": [
    {
      "id": "12345"
    }
  ]
}

Enviar Arquivo de Remessa para a VAN

Descrição: Envia o arquivo de remessa gerado para o FTP da VAN, que então envia o arquivo para o banco.

Aprovar o Arquivo Enviado para a VAN

Método: POST
Endpoint: /v1/export_batches/{id}/approve
Descrição: Aprova o arquivo de remessa enviado para a VAN.
Exemplo de Parâmetros:

POST /v1/export_batches/12345/approve

Enviar Link de Pagamento

Descrição: Envia o link de pagamento através de e-mail para que o cliente possa acessar o boleto.

Processamento do Pagamento

Cliente Paga o Boleto

Descrição: O cliente realiza o pagamento do boleto.

Enviar Arquivo de Retorno

Método: POST
Endpoint: /v1/import_batches
Descrição: Envia o arquivo de retorno processado pela VAN de volta para a Vindi, que atualiza o status do pagamento.
Exemplo de Parâmetros:

{
  "import_batches": [
    {
      "id": "67890"
    }
  ]
}

Pagamento Aprovado

Descrição: Quando o pagamento é aprovado, a Vindi processa o arquivo de retorno, atualiza o status do pagamento, e envia um webhook "Fatura Paga".
Endpoint Webhook: Fatura Paga
Notas: A Vindi notifica internamente a aprovação do pagamento.

Pagamento Não Identificado

Descrição: Se o pagamento não for identificado, a Vindi processa o arquivo de retorno e atualiza o status para indicar o não pagamento ou erro no boleto.
Endpoint Webhook: Gestão de Inadimplência
Notas: A Vindi pode notificar o cliente sobre a pendência de pagamento e tentar novamente usando um método diferente.

Reprocessamento ou Cancelamento da Assinatura

4. Cancelar Assinatura

Método: DELETE
Endpoint: /v1/subscriptions/{id}
Descrição: Cancela a assinatura se o pagamento não for identificado.
Exemplo de Parâmetros:

DELETE /v1/subscriptions/12345

Notificar Cliente sobre Pendências

Descrição: A Vindi envia notificações ao cliente sobre a pendência de pagamento e informa sobre possíveis ações para resolver a situação.

Resumo das Requisições:

Cadastrar Cliente:

Método: POST
Endpoint: /v1/customers

Exemplo de Parâmetros:

{
  "name": "Nome do Cliente",
  "email": "[email protected]",
  "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"
    }
  ]
}

Criar Assinatura:

Método: POST
Endpoint: /v1/subscriptions

Exemplo de Parâmetros:

{
  "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"
    }
  ]
}

Gerar Arquivo de Remessa:
- Método: POST
- Endpoint: /v1/export_batches
- Exemplo de Parâmetros:
```
{
  "batches": [
    {
      "id": "12345"
    }
  ]
}
```
Aprovar Arquivo de Remessa:
- Método: POST
- Endpoint: /v1/export_batches/{id}/approve
- Exemplo de Parâmetros:
```
POST /v1/export_batches/12345/approve
```
Enviar Arquivo de Retorno:
- Método: POST
- Endpoint: /v1/import_batches
- Exemplo de Parâmetros:
```
{
  "import_batches": [
    {
      "id": "67890"
    }
  ]
}
```
Cancelar Assinatura:
- Método: DELETE
- Endpoint: /v1/subscriptions/{id}
- Exemplo de Parâmetros:
```
DELETE /v1/subscriptions/12345
```

Notas Adicionais:

Webhook "Assinatura Efetuada": Usado para notificar a realização da assinatura.
Webhook "Fatura Gerada": Usado para notificar a geração da fatura.
Webhook "Fatura Paga": Usado para notificar que a fatura foi paga com sucesso.
Webhook "Gestão de Inadimplência": Usado para notificar a pendência de pagamento.
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 Bancário VAN, conforme ilustrado no diagrama.