payment-token-efi 3.0.3 → 3.1.0

package/README.md

@@ -7,12 +7,17 @@ Esta biblioteca JavaScript permite uma solução segura e eficiente para manipul
 - [**Demonstração**](#demonstração)
 - [**Instalação**](#instalação)
   - [**Web**](#web-browser)
-  - [**Gerenciador de pacote**](#gerenciador-de-pacote-npm-ou-yarn))
+  - [**Gerenciador de pacote**](#gerenciador-de-pacote-npm-ou-yarn)
   	- [**UMD**](#universal-module-definition-umd)
   	- [**ES Modules**](#ecmascript-modules-esm)
   	- [**CommonJS**](#commonjs-cjs)
   - [**Tipagens TypeScript**](#tipagens-typescript)
 - [**Utilização**](#utilização)
+	- [**Identificar a bandeira**](#identificar-a-bandeira)
+	- [**Buscar as informações de parcelamento**](#buscar-as-informações-de-parcelamento)
+	- [**Gerar o payment_token e card_mask**](#gerar-o-payment_token-e-card_mask)
+	- [**Dados de saída em caso de falha**](#dados-de-saída-em-caso-de-falha)
+	- [**Exemplos práticos**](#exemplos-práticos)
 - [**Criação da cobrança**](#criação-da-cobrança)
 - [**Documentação Adicional**](#documentação-adicional)
 - [**Comunidade e suporte**](#comunidade-e-suporte)
@@ -42,7 +47,7 @@ Realize o [download da biblioteca](https://raw.githubusercontent.com/efipay/js-p
   ```
 - **Importação por CDN**
   ```html
-  <script src="https://cdn.jsdelivr.net/gh/efipay/js-payment-token-efi/dist/payment-token-efi-umd.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/payment-token-efi/dist/payment-token-efi-umd.min.js"></script>
   ```
   _**Obs**: neste tipo de aplicação, utilize o módulo **umd**._
 
@@ -97,7 +102,7 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
 
 <br>
 
-- ### **Identificar a bandeira**
+### **Identificar a bandeira**
 
   - **Dados de entrada:**
 
@@ -109,13 +114,13 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
   - **Exemplo:**
 
     ```js
-    async function identificarBandeira() {
+    async function identifyBrand() {
       try {
-        const bandeira = await EfiPay.CreditCard
+        const brand = await EfiPay.CreditCard
           .setCardNumber("4485785674290087")
           .verifyCardBrand();
 
-        console.log("Bandeira: ", resultBandeira);
+        console.log("Bandeira: ", brand);
       } catch (error) {
         console.log("Código: ", error.code);
         console.log("Nome: ", error.error);
@@ -132,7 +137,7 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
 
 <br>
 
-- ### **Buscar as informações de parcelamento**
+### **Buscar as informações de parcelamento**
 
   - **Dados de entrada:**
 
@@ -147,15 +152,16 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
   - **Exemplo:**
 
     ```js
-    async function listarParcelas() {
+    async function listInstallments() {
       try {
-        const parcelas = await EfiPay.CreditCard
+        const installments = await EfiPay.CreditCard
           .setAccount("Identificador_de_conta_aqui")
           .setEnvironment("production") // 'production' or 'sandbox'
           .setBrand("visa")
           .setTotal(28990)
-          .getInstallments()
-          .console.log("Parcelas", installments);
+          .getInstallments();
+
+          console.log("Parcelas", installments);
       } catch (error) {
         console.log("Código: ", error.code);
         console.log("Nome: ", error.error);
@@ -172,7 +178,7 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
 
 <br>
 
-- ### **Gerar o payment_token e card_mask**
+### **Gerar o payment_token e card_mask**
 
   - **Dados de entrada:**
 
@@ -186,29 +192,33 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
 	| -                 | cvv                                                              | string  | Sim         |
 	| -                 | expirationMonth `'MM'`                                           | string  | Sim         |
 	| -                 | expirationYear `'YYYY'`                                          | string  | Sim         |
+	| -                 | holderName `'Nome impresso no cartão'`               | string  | Não         |
+	| -                 | holderDocument `CPF ou CPNJ`               | string  | Não         |
 	| -                 | reuse                                                            | boolean | Não         |
 	| debugger          | Depurador de código                                              | boolean | Não         |
 
   - **Exemplo:**
 
     ```js
-    async function gerarPaymentToken() {
+    async function generatePaymentToken() {
       try {
-        const paymentTokenData = await EfiPay.CreditCard
+        const result = await EfiPay.CreditCard
           .setAccount("Identificador_de_conta_aqui")
-          .setEnvironment("production") // 'production' or 'sandbox'
+          .setEnvironment("production")
           .setCreditCardData({
             brand: "visa",
             number: "4485785674290087",
             cvv: "123",
             expirationMonth: "05",
             expirationYear: "2029",
+            holderName: "Gorbadoc Oldbuck",
+            holderDocument: "94271564656",
             reuse: false,
           })
           .getPaymentToken();
 
-        const payment_token = paymentTokenData.payment_token;
-        const card_mask = paymentTokenData.card_mask;
+        const payment_token = result.payment_token;
+        const card_mask = result.card_mask;
 
         console.log("payment_token", payment_token);
         console.log("card_mask", card_mask);
@@ -227,7 +237,7 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
 	| payment_token | Token de pagamento que representa o cartão utilizado | string |
 	| card_mask     | Máscara do cartão utilizado                          | string |
 
-* ### **Ativar debbuger**
+### **Ativar debbuger**
 
   O debugger pode ser ativado para depurar e encontrar possível falhas.
 
@@ -235,7 +245,7 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
   EfiPay.CreditCard.debugger(true);
   ```
 
-* ### **Dados de saída em caso de falha**
+### **Dados de saída em caso de falha**
 
   Em caso de erro, será retornado no try/catch o objeto com os parâmetros descritos abaixo.
 
@@ -245,6 +255,10 @@ Para utilizar esse script, é necessário passar o código **Identificador de Co
   | error             | Nome do erro.                        | string |
   | error_description | Mensagem detalhando o erro ocorrido. | string |
 
+
+### Exemplos práticos
+Disponibilizamos alguns exemplos de utilização para as principais linguaguagens de progração front-end. [Acesse aqui](https://github.com/efipay/js-payment-token-efi/tree/main/examples).
+
 <br>
 
 ---