PHP Class MrPrompt\Cielo\Cliente

Author: Thiago Paes ([email protected])
Author: Luís Otávio Cobucci Oblonczyk ([email protected])
Datei anzeigen Open project: mrprompt/cielo Class Usage Examples

Public Methods

Method Description
__construct ( Autorizacao $autorizacao, Guzzle\Http\Client $httpClient = null ) Construtor da aplicação
autoriza ( Transacao $transacao ) : AutorizacaoTransacao Autorização
autorizaPortador ( Transacao $transacao, Cartao $cartao ) : AutorizacaoPortador Autorização Direta
cancela ( Transacao $transacao ) : CancelamentoTransacao Cancelamento
captura ( Transacao $transacao ) : Captura Captura
consulta ( Transacao $transacao ) : Consulta Consulta
getAmbiente ( ) : string Retorna o ambiente utilizado para as chamadas de transação
getAmbientes ( ) : array Recupera os ambientes válidos
getCurlOpcoes ( ) : array Recupera as configurações do cURL.
getIdioma ( ) : string Retorna o idioma da venda
getIdiomas ( ) : array Recupera os idiomas válidos
iniciaTransacao ( Transacao $transacao, Cartao $cartao, string $urlRetorno ) : SolicitacaoTransacao Transacao
setAmbiente ( string $ambiente ) : Cielo Configura o ambiente a ser utilizado nas chamadas de transações
setCurlOpcoes ( array $curlOpcoes = [] ) : self Define as configurações do cURL.
setIdioma ( string $idioma ) : Cielo Idioma do pedido
setSslCertificate ( string $sslCertificate = '' ) : Cielo Seta o caminho para o arquivo certificado SSL (ex.: certificado.crt)
solicitaToken ( Transacao $transacao, Cartao $cartao ) Solicita Token
tid ( Transacao $transacao, Cartao $cartao ) : IdentificacaoTransacao TID

Protected Methods

Method Description
enviaRequisicao ( Requisicao $requisicao ) Realiza o envio da requisição à Cielo
getEndpoint ( ) : string Retorna o endereço de destino das requisições

Method Details

__construct() public method

Aqui é configurada o número e a chave de acesso do afiliado a Cielo
public __construct ( Autorizacao $autorizacao, Guzzle\Http\Client $httpClient = null )
$autorizacao Autorizacao
$httpClient Guzzle\Http\Client

autoriza() public method

Com base na resposta de autenticação, autenticada ou não-autenticada, e nas escolhas efetuadas na criação da transação, a autorização é a próxima etapa. Nesse cenário ela é cunhada de autorização automática. Embora essa escolha caiba a loja virtual, em conjunto são consideradas outras regras: - Se o portador não se autenticou com sucesso, ela não é executada - Se o portador autenticou-se com sucesso, ela pode ser executada - Se o emissor não forneceu mecanismos de autenticação, ela pode ser executada - Se a resposta do emissor não pôde ser validada, ela não é executada Nota: é nessa etapa que o saldo disponível do cartão do comprador é sensibilizado caso a transação tenha sido autorizada.
public autoriza ( Transacao $transacao ) : AutorizacaoTransacao
$transacao Transacao
return MrPrompt\Cielo\Requisicao\AutorizacaoTransacao

autorizaPortador() public method

É o pedido de autorização sem autenticação. É aquela que a loja virtual solicita os dados do cartão em seu próprio ambiente e submete um pedido de autorização. Dessa forma o lojista deve estar atento as regras de segurança. Essa funcionalidade é executada em duas etapas: a primeira, para a obtenção de um identificador e na outra, o pedido de autorização de fato. Mas por que é necessário solicitar um TID? Essa informação é uma forma de garantir que o portador não seja debitado mais de uma vez. Na ocorrência de erros durante a autorização (um timeout, por exemplo), a loja virtual deve consultar àquela transação (via TID) antes de tentar submeter uma nova. Pois num caso como esse, há possibilidade da transação ter sido autorizada.
public autorizaPortador ( Transacao $transacao, Cartao $cartao ) : AutorizacaoPortador
$transacao Transacao
$cartao Cartao
return MrPrompt\Cielo\Requisicao\AutorizacaoPortador

cancela() public method

É empregado quando o lojista decide não efetivar um pedido de compra, seja por insuficiência de estoque, desistência da compra, entre outros motivos. Seu uso faz-se necessário principalmente se a transação estiver capturada, caso contrário haverá débito na fatura do cliente para um pedido de compra não efetivado. Nota: se a transação estiver apenas autorizada e a loja queira cancelá-la, o pedido de cancelamento não é de fato necessário: vencido o prazo de captura, ela é cancelada automaticamente.
public cancela ( Transacao $transacao ) : CancelamentoTransacao
$transacao Transacao
return MrPrompt\Cielo\Requisicao\CancelamentoTransacao

captura() public method

Uma transação autorizada somente gera crédito para o estabelecimento comercial caso ela seja capturada. Por isso, todo pedido de compra que o lojista queira efetivar, deve ter a transação capturada. Para venda na modalidade de Crédito, essa confirmação pode ocorrer - Logo após a autorização (valor total) - Ou num momento posterior (valor total ou parcial) Essa definição é feita através do parâmetro capturar. Já na modalidade de Débito não existe essa abertura: toda transação de débito autorizada é automaticamente capturada.
public captura ( Transacao $transacao ) : Captura
$transacao Transacao
return MrPrompt\Cielo\Requisicao\Captura

consulta() public method

Funcionalidade de extrema importância na integração. É através dela que a loja virtual obtém uma “foto” da transação. É sempre utilizada após a loja ter recebido o retorno do fluxo da Cielo.
public consulta ( Transacao $transacao ) : Consulta
$transacao Transacao
return MrPrompt\Cielo\Requisicao\Consulta

enviaRequisicao() protected method

Realiza o envio da requisição à Cielo
protected enviaRequisicao ( Requisicao $requisicao )
$requisicao MrPrompt\Cielo\Requisicao\Requisicao

getAmbiente() public method

Retorna o ambiente utilizado para as chamadas de transação
public getAmbiente ( ) : string
return string

getAmbientes() public method

Recupera os ambientes válidos
public getAmbientes ( ) : array
return array

getCurlOpcoes() public method

Recupera as configurações do cURL.
public getCurlOpcoes ( ) : array
return array

getEndpoint() protected method

Retorna o endereço de destino das requisições
protected getEndpoint ( ) : string
return string

getIdioma() public method

Retorna o idioma da venda
public getIdioma ( ) : string
return string

getIdiomas() public method

Recupera os idiomas válidos
public getIdiomas ( ) : array
return array

iniciaTransacao() public method

Inicia uma transação de venda, retornando seu TID e demais valores
public iniciaTransacao ( Transacao $transacao, Cartao $cartao, string $urlRetorno ) : SolicitacaoTransacao
$transacao Transacao
$cartao Cartao
$urlRetorno string
return MrPrompt\Cielo\Requisicao\SolicitacaoTransacao

setAmbiente() public method

Configura o ambiente a ser utilizado nas chamadas de transações
public setAmbiente ( string $ambiente ) : Cielo
$ambiente string teste | produção (default)
return Cielo

setCurlOpcoes() public method

Define as configurações do cURL.
public setCurlOpcoes ( array $curlOpcoes = [] ) : self
$curlOpcoes array
return self

setIdioma() public method

PT (português) EN (inglês) ES (espanhol). Com base nessa informação é definida a língua a ser utilizada nas telas da Cielo. Caso não preenchido, assume-se PT.
public setIdioma ( string $idioma ) : Cielo
$idioma string
return Cielo

setSslCertificate() public method

Seta o caminho para o arquivo certificado SSL (ex.: certificado.crt)
public setSslCertificate ( string $sslCertificate = '' ) : Cielo
$sslCertificate string
return Cielo

solicitaToken() public method

Solicita um Token para trasações futuras com um determinado Cartão de Crédito
public solicitaToken ( Transacao $transacao, Cartao $cartao )
$transacao Transacao
$cartao Cartao

tid() public method

Requisita um TID (Identificador de transação) ao Web Service
public tid ( Transacao $transacao, Cartao $cartao ) : IdentificacaoTransacao
$transacao Transacao
$cartao Cartao
return MrPrompt\Cielo\Requisicao\IdentificacaoTransacao