O Dev PortalCases de Sucesso
Soluções

Fatura Avulsa - Link de Pagamento - Cartão de Crédito

Suggest Edits

Título do Fluxo: Fluxo Fatura Avulsa - Link de Pagamento (Cartão de Crédito)

Este diagrama mostra o processo de geração e pagamento de uma fatura avulsa utilizando o método de pagamento Cartão de Crédito 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 emissão de uma fatura.

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": "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 Fatura Avulsa

Método: POST
Endpoint: /v1/bills
Descrição: Cria uma fatura avulsa para o cliente cadastrado.
Exemplo de Parâmetros:

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

4. Enviar Link de Pagamento

Descrição: O sistema envia ao cliente um link de pagamento 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 fatura.

5. Cadastro do Cartão

Descrição: Para pagamentos via cartão de crédito, o cliente precisa cadastrar o cartão antes de realizar o pagamento. A resposta se o pagamento foi aprovado ou não pode não ser imediata.

Processamento do Pagamento

Pagamento Rejeitado

Descrição: Se o pagamento for rejeitado, a Vindi envia um webhook "Cobrança Rejeitada" e pode reenviar o link de pagamento para o cliente.
Endpoint Webhook: Cobrança Rejeitada
Notas: Uma notificação opcional pode ser enviada ao cliente informando que o pagamento foi rejeitado.

Pagamento Aprovado

Descrição: Se o pagamento for aprovado, a Vindi processa a baixa na fatura e envia um webhook "Fatura Paga".
Endpoint Webhook: Fatura Paga

Resumo das Requisições:

  1. Cadastrar Cliente:

    • Método: POST
    • Endpoint: /v1/customers
    • Exemplo de Parâmetros: 
      {
  "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 Fatura Avulsa:

    • Método: POST
    • Endpoint: /v1/bills
    • Exemplo de Parâmetros: 
      {
  "customer_id": 873101,
  "payment_method_code": "credit_card",
  "bill_items": [
    {
      "product_id": 88171,
      "amount": 150,
      "description": "Teste Vindi parcela R$5,90"
    }
  ]
}

Notas Adicionais:

  • LINK DE FATURA: Utilize o parâmetro URL do retorno da requisição para enviar o link de pagamento ao cliente.
  • Webhook "Cobrança Rejeitada": Usado para notificar que o pagamento foi rejeitado. Opcionalmente, o sistema pode reenviar o link de pagamento ao cliente.
  • 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 faturas avulsas via Cartão de Crédito, conforme ilustrado no diagrama.

Updated about 1 year ago