hildebrandosegundo / cielo

Client para a API 3.0 da Cielo em node.js

cielo

Client para a API 3.0 da Cielo em Node.Js

Índice

Início

• Instalação
• Como Utilizar
• Paramêtros de criação

Cartão de Crédito

• Criando uma transação simples
• Criando uma transação completa
• Criando uma venda com Autenticação
• Criando uma venda com Análise de Fraude
• Criando uma venda com Card Token
• Capturando uma venda
• Cancelando uma venda

Cartão de Débito

• Criando uma venda simplificada

Transferência Eletrônica

• Criando uma venda simplificada

Boleto

• Criando uma venda de Boleto

API Reference

Autor

License

Installation

npm install --save cielo

Como utilizar?

Iniciando

var paramsCielo = {
    'MerchantId': 'xxxxxxxxxxxxxxxxxxxxxxx',
    'MerchantKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
    'RequestId': 'xxxxxxx', // Opcional - Identificação do Servidor na Cielo
    'sandbox': true, // Opcional - Ambiente de Testes
    'debug': true // Opcional - Exibe os dados enviados na requisição para a Cielo
}

var cielo = require('cielo')(paramsCielo);

Paramêtros de criação

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
sandbox	Ambiente de testes da Cielo	Não	false
debug	Exibe requisição da transação no console	Não	false

Cartão de Crédito

Criando uma transação simples

var dadosSale = {  
   "MerchantOrderId":"2014111703",
   "Customer":{  
      "Name":"Comprador crédito simples"
   },
   "Payment":{  
     "Type":"CreditCard",
     "Amount":15700,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{  
         "CardNumber":"0000000000000001",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}

cielo.creditCard.simpleTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Criando uma transação completa

cielo.creditCard.completeTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Criando uma venda com Autenticação

cielo.creditCard.authenticationTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Criando uma venda com Análise de Fraude

cielo.creditCard.fraudAnalysisTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Criando uma venda com Card Token

cielo.creditCard.cardTokenTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Capturando uma venda

var dadosSale = {
    paymentId: '01df6e28-6ddd-45db-a095-903c1adb170a',
    amount: '15700'
}

cielo.creditCard.captureSaleTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Cancelando uma venda

var dadosSale = {
    paymentId: '01df6e28-6ddd-45db-a095-903c1adb170a',
    amount: '15700'
}

cielo.creditCard.cancelSale(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Cartão de Débito

Criando uma venda simplificada

var dadosSale = {  
   "MerchantOrderId":"2014121201",
   "Customer":{  
      "Name":"Comprador Cartão de débito"
   },
   "Payment":{  
     "Type":"DebitCard",
     "Amount":15700,
     "ReturnUrl":"http://www.cielo.com.br",
     "DebitCard":{  
         "CardNumber":"4551870000000183",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}

cielo.debitCard.simpleTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Pagamentos com Transferência Eletronica

Criando uma venda simplificada

var dadosSale = {  
    "MerchantOrderId":"2014111706",
    "Customer":
    {  
        "Name":"Comprador Transferência Eletronica"
    },
    "Payment":
    {  
        "Type":"EletronicTransfer",
        "Amount":15700,
        "Provider":"Bradesco",
        "ReturnUrl":"http://www.banzeh.com.br"
    }
}

cielo.bankSlip.simpleTransaction(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

Boleto

Criando uma venda de Boleto

var dadosSale = {  
    "MerchantOrderId":"2014111706",
    "Customer":
    {  
        "Name":"Comprador Teste Boleto",
        "Identity": "1234567890",
        "Address":
        {
          "Street": "Avenida Marechal Câmara",
          "Number": "160",  
          "Complement": "Sala 934",
          "ZipCode" : "22750012",
          "District": "Centro",
          "City": "Rio de Janeiro",
          "State" : "RJ",
          "Country": "BRA"
        }
    },
    "Payment":
    {  
        "Type":"Boleto",
        "Amount":15700,
        "Provider":"INCLUIR PROVIDER",
        "Address": "Rua Teste",
        "BoletoNumber": "123",
        "Assignor": "Empresa Teste",
        "Demonstrative": "Desmonstrative Teste",
        "ExpirationDate": "5/1/2015",
        "Identification": "11884926754",
        "Instructions": "Aceitar somente até a data de vencimento, após essa data juros de 1% dia."
    }
}

cielo.boleto.sale(dadosSale, function(err, data){
    if (err){
        return console.error('ERRO', err);
    }
    return console.log(data);
})

API Reference

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

PT-Br

En

Autor

Flavio Takeuchi <[e-mail]>

Github

Twitter

License

MIT License

Copyright (c) 2017 banzeh

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.