1.0.0 • Published 2 years ago

@shanwker/auttar v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Auttar.JS

Uma forma mais fácil de implementar o websocket da Auttar em seu sistema.

Exemplo Online

Acesse https://auttar-js.netlify.com para acessar o exemplo online da implementação

Como Usar

NPM / Yarn

npm install auttarjs --save

# For Yarn, use the command below.
yarn add auttarjs

CDN

<!-- For UNPKG use the code below. -->
<script src="https://unpkg.com/auttarjs@latest/dist/index.umd.js"></script>

<!-- For JSDelivr use the code below. -->
<script src="https://cdn.jsdelivr.net/npm/auttarjs@latest/dist/index.umd.js"></script>

<script>
  console.log(Auttar);
</script>

API

Classe

import AuttarClass from 'auttarjs';

// Inicializando Classe
const  Auttar  =  new  AuttarClass({});

Argumentos

Construtor
PropiedadeTipoDefault
hoststringws://localhost:2500
debugbooleanfalse
orderIdstring''
amountfloat0
webSocketTimeoutnumber60000

credit - Venda no crédito

Auttar.credit(installments =  1, withInterest = false)

debit - Vennda no Debito

Auttar.debit(isVoucher = false)

requestCancellation - Desfazimento da venda ativa

Auttar.requestCancellation()

cancel - Extorno de venda

Auttar.cancel(prop = {})

Argumentos

PropiedadeTipoDefault
operacaonumberÚltima operação realizada
dataTransacaostringData da última operação realizada
amountfloatValor da última operação realizada
nsuCTFstringnsuCTF da última operação realizada

Exemplos

import AuttarClass from 'auttarjs';

// Inicializando Classe
const  Auttar  =  new  AuttarClass({
orderId:  '123456ABCDEF',
amount:  100.90
});

//Realizando pagamento com cartão de crédito.
Auttar.credit();

//Realizando pagamento com cartão de crédito parcelado
Auttar.credit(3);

//Realizando pagamento com cartão de crédito parcelado juros pela administradora
Auttar.credit(3,  true);

//Realizando pagamento com cartão de débito.
Auttar.debit();

//Realizando desfazimento total de operação
Auttar.requestCancellation();

//Realizando extorno da última compra
Auttar.cancel();

//Realizando confirmação da operação
Auttar.confirm();