Assinatura - Checkout Transparente - PIX

Título do Fluxo: Fluxo de Assinatura - PIX

Este diagrama mostra o processo de geração e pagamento de uma assinatura utilizando o método de pagamento Pix 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. Realiza a Compra

Descrição: O cliente inicia o processo de assinatura do serviço.

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": "[e-mail]",
  "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 e gera a fatura.
Exemplo de Parâmetros:

JSON

{
  "plan_id": 12345,
  "customer_id": 873101,
  "payment_method_code": "pix",
  "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.

Enviar Link de Pagamento

Descrição: O sistema envia ao cliente um link de pagamento contendo um QR Code ou chave Pix para que ele possa realizar o pagamento da fatura.
Notas: O link para pagamento da fatura é retornado na resposta da requisição de criação da assinatura.

Processamento do Pagamento

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": "[e-mail]",
       "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": "pix",
       "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 Pix, conforme ilustrado no diagrama.