Aprova Fácil
Gem para integração com Gateway Aprova Fácil da Cobrebem.
Mais informações: http://www.cobrebem.com/imagens/ManualAPFIntegracaoWebService.pdf
COMO USAR
Configuração
O primeiro passo é instalar a gem.
gem install aprova_facil
Depois de instalar, você precisará informar seus dados.
AprovaFacil::Config.usuario = '<usuario>' # usuário fornecido pela Cobrebem
No caso de um abiente de teste ou desenvolvimento também é possível passar o parâmetro
AprovaFacil::Config.teste = true
Efetuando uma aprovação
Para efetuar uma compra é necessário criar uma instância da classe CartaoCredito com os dados da compra e do cartão de crédito a ser debitado.
cartao = AprovaFacil::CartaoCredito.new(
:valor => 25.00,
:numero_cartao => '4073020000000002',
:codigo_seguranca => '123',
:mes_validade => '10',
:ano_validade => '14',
:bandeira => AprovaFacil::CartaoCredito::Bandeira::VISA
:ip_comprador => '192.168.1.1',
:nome_portador => 'Ford Prefect'
)
Outros atributos disponíveis
Atributo | Descrição | Obrigatório? | Valor padrão |
---|---|---|---|
:documento | Número do documento do sistema | Não | |
:valor | Valor da transação | Sim | 0.00 |
:numero_cartao | Número do cartão | Sim | |
:codigo_seguranca | Código de segurança do cartão | Sim | |
:mes_validade | Mês de validade do cartão | Sim | |
:ano_validade | Ano de validade do cartão | Sim | |
:ip_comprador | Ip do comprador | Sim | |
:parcelas | Quantidade de parcelas | Não | 01 |
:bandeira | Bandeira, veja abaixo | Não | VISA |
:nome_portador | Nome do portador do cartão | Não | |
:cpf_portador | CPF do portador do cartão | Não | |
:data_nascimento | Data de nascimento do portador do cartão | Não | |
:nome_mae | Nome da mão do portador do cartão | Não | |
:parcelamento_administradora | Informa se será parcelado pela loja ou pela adminsitrador | Não | True |
Bandeiras
AprovaFacil::CartaoCredito::Bandeira::VISA
AprovaFacil::CartaoCredito::Bandeira::MASTERCARD
AprovaFacil::CartaoCredito::Bandeira::DINERS
AprovaFacil::CartaoCredito::Bandeira::AMEX
AprovaFacil::CartaoCredito::Bandeira::HIPERCARD
AprovaFacil::CartaoCredito::Bandeira::JCB
AprovaFacil::CartaoCredito::Bandeira::SOROCRED
AprovaFacil::CartaoCredito::Bandeira::AURA
Após criar o cartão, deve-se solicitar a aprovação da transação.
aprova_facil = AprovaFacil.new
resultado = aprova_facil.aprovar(cartao)
Resultados
:aprovada # True ou false
:resultado # Descrição do resultado do pedido
:codigo_autorizacao # Código de autorização retornado pela administradora do cartão.
:transacao # ID da transação do Aprova Fácil.
:cartao_mascarado # Número do cartão de crédito mascarado. Eg. 444433******1111
:numero_documento # ID do pedido.
Captura
Entende-se por captura o processo de confirmação de uma transação. Em outras palavras, captura é a efetivação da venda.
De acordo com os padrões ISO 8583, todas as transações aprovadas pelas Administradoras de Cartões de Crédito devem ser capturadas (confirmadas) pela aplicação do Lojista.
Após essa confirmação, a reserva de crédito estabelecida na aprovação é transformada em um débito efetivo no cartão do Cliente.
Caso a transação não seja confirmada no prazo estipulado, a mesma será automaticamente desfeita, sem a efetivação do débito.
Tal informação será exibida no campo “Data Hora Cancelamento” do extrato do Aprova Fácil.
aprova_facil = AprovaFacil.new
resultado = aprova_facil.capturar('123123123') # Numero da transação
Resultados
:capturado # True ou false
:resultado # Descrição da captura
Cancelamento
Como todas as transações precisam ser confirmadas pelo Lojista, um cancelamento de transação só faz sentido após a sua confirmação.
Após a confirmação do Lojista (captura), a transação ainda pode ser cancelada antes que o sistema de cobrança das administradoras debitem o valor do cliente (após esse prazo o valor será debitado e a reversão da venda deverá ser feita via Estorno).
aprova_facil = AprovaFacil.new
resultado = aprova_facil.cancelar('123123') # Numero da transação
Resultados
:cancelado # true ou false
:resultado # Descrição do cancelamento
:nsu_Cancelamento # Número de cancelamento da Administradora
Recorrência
A recorrência de transações é utilizada quando se deseja efetuar novos débitos em um cartão de crédito, em qualquer periodicidade, podendo ainda alterar o valor do débito a cada cobrança.
O processo de "recobrança" em uma recorrência, se difere do processo de "recobrança" em um agendamento A recobrança em uma recorrência é comandada pela aplicação do lojista. Nesse caso, a última transação aprovada e confirmada previsa ser passada como parâmetro.
aprova_facil = AprovaFacil.new
resultado = aprova_facil.recobrar('123123', 25.00)
Assinatura do método de recobrança.
def recobrar(transacao, valor, parcelas = '01', parcelamento_admin = true )
Resultados
:aprovada # True ou false
:resultado # Descrição da aprovação do resultado do pedido
:codigo_autorizacao # Código de autorização retornado pela Administradora do cartão de crédito
:transacao # ID da transação Aprova Fáci
:cartao_mascarado # Número mascarado do Cartão de Crédito Eg. 444433******1111
:numero_documento # ID do pedido da companhia
AUTOR:
Bruno Frank Silva Cordeiro bfscordeiro (at) gmail (dot) com
LICENÇA:
(The MIT License)
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.