Fatura Avulsa - Altera Método de Pagamento - Link de Pagamento

Título do Fluxo: Fluxo de Alteração de Métodos de Pagamentos via Link de Pagamentos - Fatura Avulsa

Este diagrama mostra como alterar o método de pagamento de uma fatura avulsa, usando diferentes métodos de pagamento (Pix, Boleto e Cartão de Crédito) na plataforma Vindi. Aqui está a descrição detalhada de cada passo no fluxo.

1. Verificar Código de ID de Fatura

Descrição: Primeiro, é necessário verificar o código de ID da fatura nas informações internas para próximas requisições.

2. Cancelar Fatura Anterior com Status "Pending"

Método: DELETE
Endpoint: /v1/bills/{id da bill}
Descrição: Cancela a fatura anterior que está com o status "pending".
Exemplo de Parâmetros:

HTTP

DELETE /v1/bills/12345

3. Emitir Nova Fatura com Novo Método de Pagamento

Método: POST
Endpoint: /v1/bills/{id da fatura}
Descrição: Emite uma nova fatura com o novo método de pagamento e informações de valores e vencimento armazenados da fatura anterior.
Exemplo de Parâmetros:

JSON

{
  "customer_id": 873101,
  "payment_method_code": "pix",
  "bill_items": [
    {
      "product_id": 88171,
      "amount": 150,
      "description": "Teste Vindi parcela R$5,90"
    }
  ],
  "payment_profile": {
    "gateway_token": "1e6e5231-4323-41ee-bb9d-8902dd60d0f7"
  }
}

4. Retornar Resultado da Requisição

Descrição: A API retorna o resultado da requisição com o URL do link de pagamentos.

5. Atualizar Informações

Descrição: Atualiza as informações de valores e vencimento para as próximas requisições.

Notas do Autor do Diagrama:

• "Pix Vindi Pagamentos" usa "payment_method_code": "pix"
• "Cartão de crédito" usa "payment_method_code": "credit_card"
• "Boleto Vindi Pagamentos" usa "payment_method_code": "bank_slip"

Descrição por Método de Pagamento:

Método de Pagamento: Pix

1. Cancelar Fatura Anterior

   • Método: DELETE
   • Endpoint: /v1/bills/{id da bill}
   • Descrição: Cancela a fatura anterior com status "pending".

2. Emitir Nova Fatura com Pix

   • Método: POST
   • Endpoint: /v1/bills/{id da fatura}
   • Descrição: Emite uma nova fatura com o método de pagamento "pix".
   • Exemplo de Parâmetros:
     JSON

     {
       "customer_id": 873101,
       "payment_method_code": "pix",
       "bill_items": [
         {
           "product_id": 88171,
           "amount": 150,
           "description": "Teste Vindi parcela R$5,90"
         }
       ],
       "payment_profile": {
         "gateway_token": "1e6e5231-4323-41ee-bb9d-8902dd60d0f7"
       }
     }
     

Método de Pagamento: Boleto Bancário

1. Cancelar Fatura Anterior

   • Método: DELETE
   • Endpoint: /v1/bills/{id da bill}
   • Descrição: Cancela a fatura anterior com status "pending".

2. Emitir Nova Fatura com Boleto Bancário

   • Método: POST
   • Endpoint: /v1/bills/{id da fatura}
   • Descrição: Emite uma nova fatura com o método de pagamento "bank_slip".
   • Exemplo de Parâmetros:
     JSON

     {
       "customer_id": 873101,
       "payment_method_code": "bank_slip",
       "bill_items": [
         {
           "product_id": 88171,
           "amount": 150,
           "description": "Teste Vindi parcela R$5,90"
         }
       ]
     }
     

Método de Pagamento: Cartão de Crédito

1. Cancelar Fatura Anterior

   • Método: DELETE
   • Endpoint: /v1/bills/{id da bill}
   • Descrição: Cancela a fatura anterior com status "pending".

2. Emitir Nova Fatura com Cartão de Crédito

   • Método: POST
   • Endpoint: /v1/bills/{id da fatura}
   • Descrição: Emite uma nova fatura com o método de pagamento "credit_card".
   • Exemplo de Parâmetros:
     JSON

     {
       "customer_id": 873101,
       "payment_method_code": "credit_card",
       "bill_items": [
         {
           "product_id": 88171,
           "amount": 150,
           "description": "Teste Vindi parcela R$5,90"
         }
       ],
       "payment_profile": {
         "gateway_token": "1e6e5231-4323-41ee-bb9d-8902dd60d0f7"
       }
     }
     

Envio de Notificação

Descrição: Após a atualização, o sistema envia uma notificação via e-mail/SMS (caso ativada) com o link de pagamento para quitação ao cliente.