#74652 - 09.3.1 Gerar assinatura para boleto em 4 parcelas (Documentação)

5f8e1266 · Ruan Gabriel de Barros · c4d377df · 5f8e1266 · 5f8e1266 · 5f8e1266
Commit 5f8e1266 authored 1 year ago by Ruan Gabriel de Barros
Hide whitespace changes
Inline Side-by-side

Showing

with 158 additions and 6 deletions
+158 -6
--- a/README.md
+++ b/README.md
@@ -87,7 +87,9 @@ POST /pagamentos/v1/fatura
 # Operações Vindi
 - [Principais Características](/wiki/README-vindi.md#principais-caracteríticas)
  - [Fatura Cartão de Crédito](/wiki/README-vindi.md#fatura-cartão-de-crédito)
-  - [Assinatura Cartão de Crédito](/wiki/README-vindi.md#assinatura-cartão-de-crédito)
+  - [Fatura Boleto](/wiki/README-vindi.md#fatura-boleto)
+  - [Fatura Pix](/wiki/README-vindi.md#fatura-pix)
+  - [Assinatura](/wiki/README-vindi.md#assinatura)
  - [Planos](/wiki/README-vindi.md#planos)
    - [Criar Plano](/wiki/README-vindi.md#criar-plano)
    - [Listar Planos](/wiki/README-vindi.md#listar-planos)

--- a/src/Payment/IntegracaoPagamentos.Models/V1/Request/Vindi/AssinaturaVindiRequest.cs
+++ b/src/Payment/IntegracaoPagamentos.Models/V1/Request/Vindi/AssinaturaVindiRequest.cs
@@ -26,6 +26,11 @@ namespace IntegracaoPagamentos.Models.V1.Request.Vindi
        /// <summary>
        /// Método de pagamento a ser utilizado na Assinatura
        /// </summary>
+        /// <example>
+        ///     Boleto = 1,
+        ///     CartaoCredito = 2,
+        ///     Pix = 3
+        /// </example>
        [Required(ErrorMessage = "O campo {0} é obrigatório")]
        public MetodoPagamento MetodoPagamento { get; set; }
    }

--- a/wiki/README-vindi.md
+++ b/wiki/README-vindi.md
@@ -90,26 +90,171 @@ Com o serviço da Vindi, não é necessário criar uma página para capturar os
 }
 ```

+## Fatura Boleto
+```js
+POST /pagamentos/vindi/v1/fatura/boleto
+```
+
+## Modelo do Json enviado para criação da fatura
+```json
+{
+    "descricao": "Contratação do plano X da Engarde",
+    "tokencartao": "c368c1ed-1f85-4279-8284-964e62f363dc",
+    "fatura": {
+        "emailcliente": "teste@teste.adv.br",
+        "emailcopia": "",
+        "datavencimento": "25/09/2023",
+        "numeroparcelas": "1",
+        "itenscobranca": [
+            {
+                "descricao": "Seguro",
+                "quantidade": "1",
+                "valor": "4990"
+            }
+        ],
+        "descontoemcentavos": "0",
+        "ignorarenvioemailcobranca": "false",
+        "idassinatura": "",
+        "cliente": {
+            "cpfcnpj": "82513595033",
+            "nome": "Teste teste",
+            "dddtelefone": "11",
+            "numerotelefone": "988277337",
+            "email": "teste@teste.adv.br",
+            "endereco": {
+                "cep": "01327010",
+                "numeroendereco": "1234",
+                "complementoendereco": "",
+                "logradouro": "Rua 1026",
+                "bairro": "Conjunto Ceará",
+                "cidade": "Fortaleza",
+                "estado": "CE",
+                "pais": "BR"
+            },
+            "datanascimento": "08/04/1986",
+            "listatelefones": [
+                {
+                    "dddtelefone": "85",
+                    "numerotelefone": "998598647",
+                    "codigoareapais": "55",
+                    "tipotelefone": "1"
+                }
+            ]
+        },
+        "chaveidentexterna": "ABS17763",
+        "splits": [
+            {
+                "valoremcentavos": "0",
+                "percentual": 0,
+                "agregarpercentualevalor": "false",
+                "identificadorconta": ""
+            }
+        ],
+        "variaveiscustomizadas": [
+            {
+                "nome": "Nota",
+                "valor": "Fatura gerada para pagamento de seguro"
+            }
+        ],
+        "cobrancaduasetapas": "false",
+        "identificadorapi": "vindi"
+    }
+}
+```
+
+## Fatura Pix
+```js
+POST /pagamentos/vindi/v1/fatura/pix
+```
+
+## Modelo do Json enviado para criação da fatura
+```json
+{
+    "descricao": "Contratação do plano X da Engarde",
+    "tokencartao": "c368c1ed-1f85-4279-8284-964e62f363dc",
+    "fatura": {
+        "emailcliente": "teste@teste.adv.br",
+        "emailcopia": "",
+        "datavencimento": "25/09/2023",
+        "numeroparcelas": "1",
+        "itenscobranca": [
+            {
+                "descricao": "Seguro",
+                "quantidade": "1",
+                "valor": "4990"
+            }
+        ],
+        "descontoemcentavos": "0",
+        "ignorarenvioemailcobranca": "false",
+        "idassinatura": "",
+        "cliente": {
+            "cpfcnpj": "82513595033",
+            "nome": "Teste teste",
+            "dddtelefone": "11",
+            "numerotelefone": "988277337",
+            "email": "teste@teste.adv.br",
+            "endereco": {
+                "cep": "01327010",
+                "numeroendereco": "1234",
+                "complementoendereco": "",
+                "logradouro": "Rua 1026",
+                "bairro": "Conjunto Ceará",
+                "cidade": "Fortaleza",
+                "estado": "CE",
+                "pais": "BR"
+            },
+            "datanascimento": "08/04/1986",
+            "listatelefones": [
+                {
+                    "dddtelefone": "85",
+                    "numerotelefone": "998598647",
+                    "codigoareapais": "55",
+                    "tipotelefone": "1"
+                }
+            ]
+        },
+        "chaveidentexterna": "ABS17763",
+        "splits": [
+            {
+                "valoremcentavos": "0",
+                "percentual": 0,
+                "agregarpercentualevalor": "false",
+                "identificadorconta": ""
+            }
+        ],
+        "variaveiscustomizadas": [
+            {
+                "nome": "Nota",
+                "valor": "Fatura gerada para pagamento de seguro"
+            }
+        ],
+        "cobrancaduasetapas": "false",
+        "identificadorapi": "vindi"
+    }
+}
+```
+
 Atualmente, não há opção de cobrança em duas etapas para este provedor de pagamento.

-## Assinatura Cartão de Crédito
+## Assinatura
 ```js
-POST /pagamentos/vindi/v1/assinatura/cartao
+POST /pagamentos/vindi/v1/assinatura
 ```

-Com o serviço da Vindi, não é necessário criar uma página para capturar os dados do cartão, será retornado um link para realizar o pagamento da fatura.
+Com o serviço da Vindi, não é necessário criar uma página para capturar os dados de pagamento, será retornado um link para realizar o pagamento da fatura.

 ## Modelo do Json enviado para criação da assinatura
 ```json
 {
    "ChaveIdentExterna": "engarde.20043150",
    "IdentificadorPlano": "engarde_65_1",
+    "MetodoPagamento": "CartaoCredito", 
    "ItensProduto": [
        {
            "Ciclos": 12,
            "Quantidade": 1,
            "Precificacao": {
-                "Preco": 6.0225,
+                "Preco": 6.0225
            },
            "NomeProduto": "Assinatura Assistência Bravos Engarde",
            "IdentificadorProduto": "engarde_65"
@@ -131,7 +276,7 @@ Com o serviço da Vindi, não é necessário criar uma página para capturar os
            "Estado": "SP",
            "Pais": "BR"
        },
-        "DataNascimento": null,
+        "DataNascimento": null
    },
    "IdentificadorApi": "vindi"
 }