cielo

API 3.0 da Cielo em NodeJs com suporte Typescript


Índice

#### Início
+ Instalação
+ Como Utilizar
+ Paramêtros de criação
+ Handle Erros

#### Cartão de Crédito
+ Criando uma transação simples @TODO
+ Criando uma transação completa @TODO
+ Criando uma venda com Autenticação @TODO
+ Criando uma venda com Análise de Fraude @TODO
+ Criando uma venda com Card Token@TODO
+ Capturando uma venda@TODO
+ Cancelando uma venda@TODO

#### Cartão de Débito
+ Criando uma venda simplificada@TODO

#### Transferência Eletrônica
+ Criando uma venda simplificada@TODO

#### Boleto
+ Criando uma venda de Boleto@TODO

$3

+ Criando Recorrências@TODO
+ Modificando Recorrências@TODO
* Modificando dados do comprador@TODO
* Modificando data final da Recorrência@TODO
* Modificando intevalo da Recorrência@TODO
* Modificando dia da Recorrência@TODO
* Modificando o valor da Recorrência@TODO
* Modificando data do próximo Pagamento@TODO
* Modificando dados do Pagamento da Recorrência@TODO
* Desabilitando um Pedido Recorrente@TODO
* Reabilitando um Pedido Recorrente@TODO

#### Cartões
+ Gerando o token de um cartão

#### Consultas
+ Consultando as transações usando PaymentID@TODO
+ Consultando as transações usando MerchandOrderID@TODO
+ Consulta de Cardbin
+ Consulta de Recorrência@TODO

#### API Reference
#### Testes
#### License

Installation

``js
npm install --save cielo-api
`

Como utilizar?

$3

`js
const ApiCielo = require('cielo-api').CieloApi

Ou importando com Typescript

import { CieloApi } from 'cielo-api'

const cielo = new CieloApi.Cielo({
MerchantId: 'xxxxxxxxxxxxxxxxxxxxxxx',
MerchantKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
RequestId: 'xxxxxxx', // Opcional - Identificação do Servidor na Cielo
isSandbox: true // Opcional - Ambiente de Testes
}
cielo.

ou então você poderá chamar assim:

CieloApi.getInstance.

`


Lidando com Erros

$3

`js
try {
throw CieloError({message: 'todas as propriedades aqui é opcional :)'})
} catch (error) {
if(error instanceof CieloError) {
error.message
error.statusCode
error.erros[0].Code
error.erros[0].Message

}
}
`

$3

| Campo | Descrição | Obrigatório? | Default |
| ------------- |:-------------:| -----:| -----:|
| MerchantId | Identificador da loja na Cielo. | Sim | null |
| MerchantKey | Chave Publica para Autenticação Dupla na Cielo. | Sim | null |
| RequestId | Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. | Não | null |
| isSandBox | Ambiente de testes da Cielo | Não | false |

Cartão de Crédito

$3


`js

try {
const res = await CieloApi.getInstance.createSaleCardTokenized({
Customer: {
Name: "Nome do Cliente"
},
MerchantOrderId: "123124124123",
Payment: {
Amount: 100,
CreditCard: {
Brand: "Master",
CardToken: "123023-32322-44224-22223-444-444"
},
Installments: 1,
Type: 'CreditCard'
}
})

}catch (e) {
console.log(e.message)
}

`

Cartões

$3


`js

try {
const res = await CieloApi.getInstance.createTokenizedCard({
Brand: "Visa",
CardNumber: "4184669814440303",
CustomerName: "Jesus Burns",
ExpirationDate: "04/2021",
Holder: "955"
})

}catch (e) {
console.log(e.message)
}

`

Consultas

$3

`js

try {
const res = await CieloApi.getInstance.getCardbin(123456)

}catch (e) {
console.log(e.message)
}

`




API Reference

Consulte os campos necessários na documentação da Cielo

PT-Br

En

Testes

Para rodar os testes automatizados, apenas execute o seguinte comando

`
npm test
``

Autor

Lucas Breitembach

License

MIT License

Copyright (c) 2019 Lucas Breitembach

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.