<?php
/**
 * PayZen V2-Payment Module version 1.8.0 for PrestaShop 1.5-1.7. Support contact : support@payzen.eu.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Academic Free License (AFL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/afl-3.0.php
 *
 * @category  payment
 * @package   payzen
 * @author    Lyra Network (http://www.lyra-network.com/)
 * @copyright 2014-2016 Lyra Network and contributors
 * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
 */

if (! defined('_PS_VERSION_')) {
    exit();
}

require_once 'PayzenApi.php';

if (! class_exists('PayzenResponse', false)) {

    /**
     * Class representing the result of a transaction (sent by the IPN URL or by the client return).
     */
    class PayzenResponse
    {
        const TYPE_RESULT = 'result';
        const TYPE_AUTH_RESULT = 'auth_result';
        const TYPE_WARRANTY_RESULT = 'warranty_result';
        const TYPE_RISK_CONTROL = 'risk_control';
        const TYPE_RISK_ASSESSMENT = 'risk_assessment';

        /**
         * Raw response parameters array.
         *
         * @var array[string][string]
         */
        private $rawResponse = array();

        /**
         * Certificate used to check the signature.
         *
         * @see PayzenApi::sign
         * @var string
         */
        private $certificate;

        /**
         * Value of vads_result.
         *
         * @var string
         */
        private $result;

        /**
         * Value of vads_extra_result.
         *
         * @var string
         */
        private $extraResult;

        /**
         * Value of vads_auth_result
         *
         * @var string
         */
        private $authResult;

        /**
         * Value of vads_warranty_result
         *
         * @var string
         */
        private $warrantyResult;

        /**
         * Transaction status (vads_trans_status)
         *
         * @var string
         */
        private $transStatus;

        /**
         * Constructor for PayzenResponse class.
         * Prepare to analyse check URL or return URL call.
         *
         * @param array[string][string] $params
         * @param string $ctx_mode
         * @param string $key_test
         * @param string $key_prod
         * @param string $encoding
         */
        public function __construct($params, $ctx_mode, $key_test, $key_prod)
        {
            $this->rawResponse = PayzenApi::uncharm($params);
            $this->certificate = $ctx_mode == 'PRODUCTION' ? $key_prod : $key_test;

            // payment results
            $this->result = self::findInArray('vads_result', $this->rawResponse, null);
            $this->extraResult = self::findInArray('vads_extra_result', $this->rawResponse, null);
            $this->authResult = self::findInArray('vads_auth_result', $this->rawResponse, null);
            $this->warrantyResult = self::findInArray('vads_warranty_result', $this->rawResponse, null);

            $this->transStatus = self::findInArray('vads_trans_status', $this->rawResponse, null);
        }

        /**
         * Check response signature.
         * @return bool
         */
        public function isAuthentified()
        {
            return $this->getComputedSignature() == $this->getSignature();
        }

        /**
         * Return the signature computed from the received parameters, for log/debug purposes.
         * @param bool $hashed
         * @return string
         */
        public function getComputedSignature($hashed = true)
        {
            return PayzenApi::sign($this->rawResponse, $this->certificate, $hashed);
        }

        /**
         * Check if the payment was successful (waiting confirmation or captured).
         * @return bool
         */
        public function isAcceptedPayment()
        {
            $confirmedStatuses = array(
                'AUTHORISED',
                'AUTHORISED_TO_VALIDATE',
                'CAPTURED',
                'CAPTURE_FAILED' /* capture will be redone */
            );

            return in_array($this->transStatus, $confirmedStatuses) || $this->isPendingPayment();
        }

        /**
         * Check if the payment is waiting confirmation (successful but the amount has not been
         * transfered and is not yet guaranteed).
         * @return bool
         */
        public function isPendingPayment()
        {
            $pendingStatuses = array(
                'INITIAL',
                'WAITING_AUTHORISATION',
                'WAITING_AUTHORISATION_TO_VALIDATE',
                'UNDER_VERIFICATION'
            );

            return in_array($this->transStatus, $pendingStatuses);
        }

        /**
         * Check if the payment process was interrupted by the client.
         * @return bool
         */
        public function isCancelledPayment()
        {
            $cancelledStatuses = array('NOT_CREATED', 'ABANDONED');
            return in_array($this->transStatus, $cancelledStatuses);
        }

        /**
         * Check if the payment is to validate manually in the PayZen Back Office.
         * @return bool
         */
        public function isToValidatePayment()
        {
            $toValidateStatuses = array('WAITING_AUTHORISATION_TO_VALIDATE', 'AUTHORISED_TO_VALIDATE');
            return in_array($this->transStatus, $toValidateStatuses);
        }

        /**
         * Check if the payment is suspected to be fraudulent.
         * @return bool
         */
        public function isSuspectedFraud()
        {
            // at least one control failed ...
            $riskControl = $this->getRiskControl();
            if (in_array('WARNING', $riskControl) || in_array('ERROR', $riskControl)) {
                return true;
            }

            // or there was an alert from risk assessment module
            $riskAssessment = $this->getRiskAssessment();
            if (in_array('INFORM', $riskAssessment)) {
                return true;
            }

            return false;
        }

        /**
         * Return the risk control result.
         * @return array[string][string]
         */
        public function getRiskControl()
        {
            $riskControl = $this->get('risk_control');
            if (!isset($riskControl) || !trim($riskControl)) {
                return array();
            }

            // get a URL-like string
            $riskControl = str_replace(';', '&', $riskControl);

            $result = array();
            parse_str($riskControl, $result);

            return $result;
        }

        /**
         * Return the risk assessment result.
         * @return array[string]
         */
        public function getRiskAssessment()
        {
            $riskAssessment = $this->get('risk_assessment_result');
            if (!isset($riskAssessment) || !trim($riskAssessment)) {
                return array();
            }

            return explode(';', $riskAssessment);
        }

        /**
         * Return the value of a response parameter.
         * @param string $name
         * @return string
         */
        public function get($name)
        {
            // manage shortcut notations by adding 'vads_'
            $name = (Tools::substr($name, 0, 5) != 'vads_') ? 'vads_' . $name : $name;

            return @$this->rawResponse[$name];
        }

        /**
         * Shortcut for getting ext_info_* fields.
         * @param string $key
         * @return string
         */
        public function getExtInfo($key)
        {
            return $this->get("ext_info_$key");
        }

        /**
         * Return the expected signature received from platform.
         * @return string
         */
        public function getSignature()
        {
            return @$this->rawResponse['signature'];
        }

        /**
         * Return the paid amount converted from cents (or currency equivalent) to a decimal value.
         * @return float
         */
        public function getFloatAmount()
        {
            $currency = PayzenApi::findCurrencyByNumCode($this->get('currency'));
            return $currency->convertAmountToFloat($this->get('amount'));
        }

        /**
         * Return the payment response result.
         * @return string
         */
        public function getResult()
        {
            return $this->result;
        }

        /**
         * Return the payment response extra result.
         * @return string
         */
        public function getExtraResult()
        {
            return $this->extraResult;
        }

        /**
         * Return the payment response authentication result.
         * @return string
         */
        public function getAuthResult()
        {
            return $this->authResult;
        }

        /**
         * Return the payment response warranty result.
         * @return string
         */
        public function getWarrantyResult()
        {
            return $this->warrantyResult;
        }

        /**
         * Return all the payment response results as array.
         * @return array[string][string]
         */
        public function getAllResults()
        {
            return array(
                'result' => $this->result,
                'extra_result' => $this->extraResult,
                'auth_result' => $this->authResult,
                'warranty_result' => $this->warrantyResult
            );
        }

        /**
         * Return the payment transaction status.
         * @return string
         */
        public function getTransStatus()
        {
            return $this->transStatus;
        }

        /**
         * Return the response message translated to the payment langauge.
         * @param $result_type string
         * @return string
         */
        public function getMessage($result_type = self::TYPE_RESULT)
        {
            $text = '';

            $text .= self::translate($this->get($result_type), $result_type, $this->get('language'), true);
            if ($result_type === self::TYPE_RESULT && $this->get($result_type) === '30' /* form error */) {
                $text .= ' ' . self::extraMessage($this->extraResult);
            }

            return $text;
        }

        /**
         * Return the complete response message translated to the payment langauge.
         * @param $result_type string
         * @return string
         */
        public function getCompleteMessage($sep = ' ')
        {
            $text = $this->getMessage(self::TYPE_RESULT);
            $text .= $sep . $this->getMessage(self::TYPE_AUTH_RESULT);
            $text .= $sep . $this->getMessage(self::TYPE_WARRANTY_RESULT);

            return $text;
        }

        /**
         * Return a short description of the payment result, useful for logging.
         * @return string
         */
        public function getLogMessage()
        {
            $text = '';

            $text .= self::translate($this->result, self::TYPE_RESULT, 'en', true);
            if ($this->result === '30' /* form error */) {
                $text .= ' ' . self::extraMessage($this->extraResult);
            }

            $text .= ' ' . self::translate($this->authResult, self::TYPE_AUTH_RESULT, 'en', true);
            $text .= ' ' . self::translate($this->warrantyResult, self::TYPE_WARRANTY_RESULT, 'en', true);

            return $text;
        }

        /**
         * @deprecated Deprecated since version 1.2.1. Use <code>PayzenResponse::getLogMessage()</code>
         * or <code>PayzenResponse::getMessage()</code> instead.
         */
        public function getLogString()
        {
            return $this->getMessage();
        }

        /**
         * @deprecated Deprecated since version 1.2.0. Use <code>PayzenResponse::getOutputForPlatform()</code> instead.
         */
        public function getOutputForGateway($case = '', $extra_message = '', $original_encoding = 'UTF-8')
        {
            return $this->getOutputForPlatform($case, $extra_message, $original_encoding);
        }

        /**
         * Return a formatted string to output as a response to the notification URL call.
         *
         * @param string $case shortcut code for current situations. Most useful : payment_ok, payment_ko, auth_fail
         * @param string $extra_message some extra information to output to the payment platform
         * @param string $original_encoding some extra information to output to the payment platform
         * @return string
         */
        public function getOutputForPlatform($case = '', $extra_message = '', $original_encoding = 'UTF-8')
        {
            // predefined response messages according to case
            $cases = array(
                'payment_ok' => array(true, 'Paiement valide traité'),
                'payment_ko' => array(true, 'Paiement invalide traité'),
                'payment_ok_already_done' => array(true, 'Paiement valide traité, déjà enregistré'),
                'payment_ko_already_done' => array(true, 'Paiement invalide traité, déjà enregistré'),
                'order_not_found' => array(false, 'Impossible de retrouver la commande'),
                'payment_ko_on_order_ok' => array(false, 'Code paiement invalide reçu pour une commande déjà validée'),
                'auth_fail' => array(false, 'Echec d\'authentification'),
                'empty_cart' => array(false, 'Le panier a été vidé avant la redirection'),
                'unknown_status' => array(false, 'Statut de commande inconnu'),
                'amount_error' => array(false, 'Le montant payé est différent du montant intial'),
                'ok' => array(true, ''),
                'ko' => array(false, '')
            );

            $success = key_exists($case, $cases) ? $cases[$case][0] : false;
            $message = key_exists($case, $cases) ? $cases[$case][1] : '';

            if (! empty($extra_message)) {
                $message .= ' ' . $extra_message;
            }
            $message = str_replace("\n", ' ', $message);

            // set original CMS encoding to convert if necessary response to send to platform
            $encoding = in_array(Tools::strtoupper($original_encoding), PayzenApi::$SUPPORTED_ENCODINGS) ?
                Tools::strtoupper($original_encoding) : 'UTF-8';
            if ($encoding !== 'UTF-8') {
                $message = iconv($encoding, 'UTF-8', $message);
            }

            $content = $success ? 'OK-' : 'KO-';
            $content .= $this->get('trans_id');
            $content .= "$message\n";

            $response = '';
            $response .= '<span style="display:none">';
            $response .= htmlspecialchars($content, ENT_COMPAT, 'UTF-8');
            $response .= '</span>';
            return $response;
        }

        /**
         * Return a translated short description of the payment result for a specified language.
         * @param string $result
         * @param string $result_type
         * @param string $lang
         * @param boolean $appendCode
         * @return string
         */
        public static function translate($result, $result_type = self::TYPE_RESULT, $lang = 'fr', $appendCode = false)
        {
            // if language is not supported, use the domain default language
            if (!key_exists($lang, self::$RESPONSE_TRANS)) {
                $lang = 'fr';
            }

            $translations = self::$RESPONSE_TRANS[$lang];
            $text = self::findInArray($result ? $result : 'empty', $translations[$result_type], $translations['unknown']);

            if ($text && $appendCode) {
                $text = self::appendResultCode($text, $result);
            }

            return $text;
        }

        public static function appendResultCode($message, $result_code)
        {
            if ($result_code) {
                $message .= ' (' . $result_code . ')';
            }

            return $message . '.';
        }

        public static function extraMessage($extra_result)
        {
            $error = self::findInArray($extra_result, self::$FORM_ERRORS, 'OTHER');
            return self::appendResultCode($error, $extra_result);
        }

        public static function findInArray($key, $array, $default)
        {
            if (is_array($array) && key_exists($key, $array)) {
                return $array[$key];
            }

            return $default;
        }

        /**
         * Associative array containing human-readable translations of response codes.
         *
         * @var array
         * @access private
         */
        public static $RESPONSE_TRANS = array(
            'fr' => array(
                'unknown' => 'Inconnu',

                'result' => array(
                    'empty' => '',
                    '00' => 'Paiement réalisé avec succès',
                    '02' => 'Le marchand doit contacter la banque du porteur',
                    '05' => 'Action refusé',
                    '17' => 'Annulation',
                    '30' => 'Erreur de format de la requête',
                    '96' => 'Erreur technique'
                ),
                'auth_result' => array(
                    'empty' => '',
                    '00' => 'Transaction approuvée ou traitée avec succès',
                    '02' => 'Contacter l\'émetteur de carte',
                    '03' => 'Accepteur invalide',
                    '04' => 'Conserver la carte',
                    '05' => 'Ne pas honorer',
                    '07' => 'Conserver la carte, conditions spéciales',
                    '08' => 'Approuver après identification',
                    '12' => 'Transaction invalide',
                    '13' => 'Montant invalide',
                    '14' => 'Numéro de porteur invalide',
                    '30' => 'Erreur de format',
                    '31' => 'Identifiant de l\'organisme acquéreur inconnu',
                    '33' => 'Date de validité de la carte dépassée',
                    '34' => 'Suspicion de fraude',
                    '41' => 'Carte perdue',
                    '43' => 'Carte volée',
                    '51' => 'Provision insuffisante ou crédit dépassé',
                    '54' => 'Date de validité de la carte dépassée',
                    '56' => 'Carte absente du fichier',
                    '57' => 'Transaction non permise à ce porteur',
                    '58' => 'Transaction interdite au terminal',
                    '59' => 'Suspicion de fraude',
                    '60' => 'L\'accepteur de carte doit contacter l\'acquéreur',
                    '61' => 'Montant de retrait hors limite',
                    '63' => 'Règles de sécurité non respectées',
                    '68' => 'Réponse non parvenue ou reçue trop tard',
                    '90' => 'Arrêt momentané du système',
                    '91' => 'Emetteur de cartes inaccessible',
                    '96' => 'Mauvais fonctionnement du système',
                    '94' => 'Transaction dupliquée',
                    '97' => 'Echéance de la temporisation de surveillance globale',
                    '98' => 'Serveur indisponible routage réseau demandé à nouveau',
                    '99' => 'Incident domaine initiateur'
                ),
                'warranty_result' => array(
                    'empty' => 'Garantie de paiement non applicable',
                    'YES' => 'Le paiement est garanti',
                    'NO' => 'Le paiement n\'est pas garanti',
                    'UNKNOWN' => 'Suite à une erreur technique, le paiment ne peut pas être garanti'
                ),
                'risk_control' => array (
                    'CARD_FRAUD' => 'Contrôle du numéro de carte',
                    'SUSPECT_COUNTRY' => 'Contrôle du pays émetteur de la carte',
                    'IP_FRAUD' => 'Contrôle de l\'adresse IP',
                    'CREDIT_LIMIT' => 'Contrôle de l\'encours',
                    'BIN_FRAUD' => 'Contrôle du code BIN',
                    'ECB' => 'Contrôle e-carte bleue',
                    'COMMERCIAL_CARD' => 'Contrôle carte commerciale',
                    'SYSTEMATIC_AUTO' => 'Contrôle carte à autorisation systématique',
                    'INCONSISTENT_COUNTRIES' => 'Contrôle de cohérence des pays (IP, carte, adresse de facturation)',
                    'NON_WARRANTY_PAYMENT' => 'Contrôle le transfert de responsabilité',
                    'SUSPECT_IP_COUNTRY' => 'Contrôle Pays de l\'IP'
                ),
                'risk_assessment' => array(
                    'ENABLE_3DS' => '3D Secure activé',
                    'DISABLE_3DS' => '3D Secure désactivé',
                    'MANUAL_VALIDATION' => 'La transaction est créée en validation manuelle',
                    'REFUSE' => 'La transaction est refusée',
                    'RUN_RISK_ANALYSIS' => 'Appel à un analyseur de risques externes',
                    'INFORM' => 'Une alerte est remontée'
                )
            ),

            'en' => array(
                'unknown' => 'Unknown',

                'result' => array(
                    'empty' => '',
                    '00' => 'Action successfully completed',
                    '02' => 'The merchant must contact the cardholder\'s bank',
                    '05' => 'Action rejected',
                    '17' => 'Action canceled',
                    '30' => 'Request format error',
                    '96' => 'Technical issue'
                ),
                'auth_result' => array(
                    'empty' => '',
                    '00' => 'Approved or successfully processed transaction',
                    '02' => 'Contact the card issuer',
                    '03' => 'Invalid acceptor',
                    '04' => 'Keep the card',
                    '05' => 'Do not honor',
                    '07' => 'Keep the card, special conditions',
                    '08' => 'Confirm after identification',
                    '12' => 'Invalid transaction',
                    '13' => 'Invalid amount',
                    '14' => 'Invalid cardholder number',
                    '30' => 'Format error',
                    '31' => 'Unknown acquirer company ID',
                    '33' => 'Expired card',
                    '34' => 'Fraud suspected',
                    '41' => 'Lost card',
                    '43' => 'Stolen card',
                    '51' => 'Insufficient balance or exceeded credit limit',
                    '54' => 'Expired card',
                    '56' => 'Card absent from the file',
                    '57' => 'Transaction not allowed to this cardholder',
                    '58' => 'Transaction not allowed to this cardholder',
                    '59' => 'Suspected fraud',
                    '60' => 'Card acceptor must contact the acquirer',
                    '61' => 'Withdrawal limit exceeded',
                    '63' => 'Security rules unfulfilled',
                    '68' => 'Response not received or received too late',
                    '90' => 'Temporary shutdown',
                    '91' => 'Unable to reach the card issuer',
                    '96' => 'System malfunction',
                    '94' => 'Duplicate transaction',
                    '97' => 'Overall monitoring timeout',
                    '98' => 'Server not available, new network route requested',
                    '99' => 'Initiator domain incident'
                ),
                'warranty_result' => array(
                    'empty' => 'Payment guarantee not applicable',
                    'YES' => 'The payment is guaranteed',
                    'NO' => 'The payment is not guaranteed',
                    'UNKNOWN' => 'Due to a technical error, the payment cannot be guaranteed'
                ),
                'risk_control' => array (
                    'CARD_FRAUD' => 'Card number control',
                    'SUSPECT_COUNTRY' => 'Card country control',
                    'IP_FRAUD' => 'IP address control',
                    'CREDIT_LIMIT' => 'Card outstanding control',
                    'BIN_FRAUD' => 'BIN code control',
                    'ECB' => 'E-carte bleue control',
                    'COMMERCIAL_CARD' => 'Commercial card control',
                    'SYSTEMATIC_AUTO' => 'Systematic authorization card control',
                    'INCONSISTENT_COUNTRIES' => 'Countries consistency control (IP, card, shipping address)',
                    'NON_WARRANTY_PAYMENT' => 'Transfer of responsibility control',
                    'SUSPECT_IP_COUNTRY' => 'IP country control'
                ),
                'risk_assessment' => array(
                    'ENABLE_3DS' => '3D Secure enabled',
                    'DISABLE_3DS' => '3D Secure disabled',
                    'MANUAL_VALIDATION' => 'The transaction has been created via manual validation',
                    'REFUSE' => 'The transaction is refused',
                    'RUN_RISK_ANALYSIS' => 'Call for an external risk analyser',
                    'INFORM' => 'A warning message appears'
                )
            ),

            'es' => array(
                'unknown' => 'Desconocido',

                'result' => array(
                    'empty' => '',
                    '00' => 'Accion procesada con exito',
                    '02' => 'El mercante debe contactar el banco del portador',
                    '05' => 'Accion rechazada',
                    '17' => 'Accion cancelada',
                    '30' => 'Error de formato de solicitutd',
                    '96' => 'Problema technico'
                ),
                'auth_result' => array(
                    'empty' => '',
                    '00' => 'Transaccion aceptada o procesada con exito',
                    '02' => 'Contact el emisor de la tarjeta',
                    '03' => 'Adquirente invalido',
                    '04' => 'Retener tarjeta',
                    '05' => 'No honrar',
                    '07' => 'Retener tarjeta, condiciones especiales',
                    '08' => 'Confirmar despues identificacion',
                    '12' => 'Transaccion invalida',
                    '13' => 'Importe invalido',
                    '14' => 'Numero de portador invalido',
                    '30' => 'Error de formato',
                    '31' => 'Identificador adquirente desconocido',
                    '33' => 'Tarjeta caducada',
                    '34' => 'Fraude sospechado',
                    '41' => 'Tarjeta perdida',
                    '43' => 'Tarjeta robada',
                    '51' => 'Saldo insuficiente o limite de credito sobrepasado',
                    '54' => 'Tarjeta caducada',
                    '56' => 'Tarjeta ausente del archivo',
                    '57' => 'Transaccion no permitida a este portador',
                    '58' => 'Transaccion no permitida a este portador',
                    '59' => 'Fraude sospechado',
                    '60' => 'El aceptador de la tarjeta debe contactar el adquirente',
                    '61' => 'Limite de retirada sobrepasada',
                    '63' => 'Reglas de suguridad no cumplidas',
                    '68' => 'Respuesta no recibiba o recibida demasiado tarde',
                    '90' => 'Interrupcion temporera',
                    '91' => 'No se puede contactar el emisor de tarjeta',
                    '96' => 'Malfunction del sistema',
                    '94' => 'Transaccion duplicada',
                    '97' => 'Supervision timeout',
                    '98' => 'Servidor no disonible, nueva ruta pedida',
                    '99' => 'Incidente de dominio iniciador'
                ),
                'warranty_result' => array(
                    'empty' => 'Garantia de pago no aplicable',
                    'YES' => 'El pago es garantizado',
                    'NO' => 'El pago no es garantizado',
                    'UNKNOWN' => 'Debido a un problema tecnico, el pago no puede ser garantizado'
                ),
                'risk_control' => array (
                    'CARD_FRAUD' => 'Control de numero de tarjeta',
                    'SUSPECT_COUNTRY' => 'Control de pais de tarjeta',
                    'IP_FRAUD' => 'Control de direccion IP',
                    'CREDIT_LIMIT' => 'Control de saldo de vivo de tarjeta',
                    'BIN_FRAUD' => 'Control de codigo BIN',
                    'ECB' => 'Control de E-carte bleue',
                    'COMMERCIAL_CARD' => 'Control de tarjeta comercial',
                    'SYSTEMATIC_AUTO' => 'Control de tarjeta a autorizacion sistematica',
                    'INCONSISTENT_COUNTRIES' => 'Control de coherencia de pais (IP, tarjeta, direccion de envio)',
                    'NON_WARRANTY_PAYMENT' => 'Control de transferencia de responsabilidad',
                    'SUSPECT_IP_COUNTRY' => 'Control del pais de la IP'
                ),
                'risk_assessment' => array(
                    'ENABLE_3DS' => '3D Secure activado',
                    'DISABLE_3DS' => '3D Secure desactivado',
                    'MANUAL_VALIDATION' => 'La transaccion ha sido creada con validacion manual',
                    'REFUSE' => 'La transaccion ha sido rechazada',
                    'RUN_RISK_ANALYSIS' => 'Llamada a un analisador de riesgos exterior',
                    'INFORM' => 'Un mensaje de advertencia aparece'
                )
            ),

            'pt' => array (
                'unknown' => 'Desconhecido',

                'result' => array (
                    'empty' => '',
                    '00' => 'Pagamento realizado com sucesso',
                    '02' => 'O comerciante deve contactar o banco do portador',
                    '05' => 'Pagamento recusado',
                    '17' => 'Cancelamento',
                    '30' => 'Erro no formato dos dados',
                    '96' => 'Erro técnico durante o pagamento'
                ),
                'auth_result' => array (
                    'empty' => '',
                    '00' => 'Transação aprovada ou tratada com sucesso',
                    '02' => 'Contactar o emissor do cartão',
                    '03' => 'Recebedor inválido',
                    '04' => 'Conservar o cartão',
                    '05' => 'Não honrar',
                    '07' => 'Conservar o cartão, condições especiais',
                    '08' => 'Aprovar após identificação',
                    '12' => 'Transação inválida',
                    '13' => 'Valor inválido',
                    '14' => 'Número do portador inválido',
                    '30' => 'Erro no formato',
                    '31' => 'Identificação do adquirente desconhecido',
                    '33' => 'Data de validade do cartão ultrapassada',
                    '34' => 'Suspeita de fraude',
                    '41' => 'Cartão perdido',
                    '43' => 'Cartão roubado',
                    '51' => 'Saldo insuficiente ou limite excedido',
                    '54' => 'Data de validade do cartão ultrapassada',
                    '56' => 'Cartão ausente do arquivo',
                    '57' => 'Transação não permitida para este portador',
                    '58' => 'Transação proibida no terminal',
                    '59' => 'Suspeita de fraude',
                    '60' => 'O recebedor do cartão deve contactar o adquirente',
                    '61' => 'Valor de saque fora do limite',
                    '63' => 'Regras de segurança não respeitadas',
                    '68' => 'Nenhuma resposta recebida ou recebida tarde demais',
                    '90' => 'Parada momentânea do sistema',
                    '91' => 'Emissor do cartão inacessível',
                    '96' => 'Mau funcionamento do sistema',
                    '94' => 'Transação duplicada',
                    '97' => 'Limite do tempo de monitoramento global',
                    '98' => 'Servidor indisponível nova solicitação de roteamento',
                    '99' => 'Incidente no domínio iniciador'
                ),
                'warranty_result' => array (
                    'empty' => 'Garantia de pagamento não aplicável',
                    'YES' => 'O pagamento foi garantido',
                    'NO' => 'O pagamento não foi garantido',
                    'UNKNOWN' => 'Devido à un erro técnico, o pagamento não pôde ser garantido'
                ),
                'risk_control' => array (
                    'CARD_FRAUD' => 'Card number control',
                    'SUSPECT_COUNTRY' => 'Card country control',
                    'IP_FRAUD' => 'IP address control',
                    'CREDIT_LIMIT' => 'Card outstanding control',
                    'BIN_FRAUD' => 'BIN code control',
                    'ECB' => 'E-carte bleue control',
                    'COMMERCIAL_CARD' => 'Commercial card control',
                    'SYSTEMATIC_AUTO' => 'Systematic authorization card control',
                    'INCONSISTENT_COUNTRIES' => 'Countries consistency control (IP, card, shipping address)',
                    'NON_WARRANTY_PAYMENT' => 'Transfer of responsibility control',
                    'SUSPECT_IP_COUNTRY' => 'IP country control'
                ),
                'risk_assessment' => array(
                    'ENABLE_3DS' => '3D Secure enabled',
                    'DISABLE_3DS' => '3D Secure disabled',
                    'MANUAL_VALIDATION' => 'The transaction has been created via manual validation',
                    'REFUSE' => 'The transaction is refused',
                    'RUN_RISK_ANALYSIS' => 'Call for an external risk analyser',
                    'INFORM' => 'A warning message appears'
                )
            ),

            'de' => array (
                'unknown' => 'Unbekannt',

                'result' => array (
                    'empty' => '',
                    '00' => 'Zahlung mit Erfolg durchgeführt',
                    '02' => 'Der Händler muss die Bank des Karteninhabers kontaktieren',
                    '05' => 'Zahlung zurückgewiesen',
                    '17' => 'Stornierung',
                    '30' => 'Fehler im Format der Anfrage',
                    '96' => 'Technischer Fehler bei der Zahlung'
                ),
                'auth_result' => array (
                    'empty' => '',
                    '00' => 'Zahlung durchgeführt oder mit Erfolg bearbeitet',
                    '02' => 'Kartenausgebende Bank kontaktieren',
                    '03' => 'Ungültiger Annehmer',
                    '04' => 'Karte aufbewahren',
                    '05' => 'Nicht einlösen',
                    '07' => 'Karte aufbewahren, Sonderbedingungen',
                    '08' => 'Nach Identifizierung genehmigen',
                    '12' => 'Ungültige Transaktion',
                    '13' => 'Ungültiger Betrag',
                    '14' => 'Ungültige Nummer des Karteninhabers',
                    '30' => 'Formatfehler',
                    '31' => 'ID des Annehmers unbekannt',
                    '33' => 'Gültigkeitsdatum der Karte überschritten',
                    '34' => 'Verdacht auf Betrug',
                    '41' => 'Verlorene Karte',
                    '43' => 'Gestohlene Karte',
                    '51' => 'Deckung unzureichend oder Kredit überschritten',
                    '54' => 'Gültigkeitsdatum der Karte überschritten',
                    '56' => 'Karte nicht in der Datei enthalten',
                    '57' => 'Transaktion diesem Karteninhaber nicht erlaubt',
                    '58' => 'Transaktion diesem Terminal nicht erlaubt',
                    '59' => 'Verdacht auf Betrug',
                    '60' => 'Der Kartenannehmer muss den Acquirer kontaktieren',
                    '61' => 'Betrag der Abhebung überschreitet das Limit',
                    '63' => 'Sicherheitsregelen nicht respektiert',
                    '68' => 'Antwort nicht oder zu spät erhalten',
                    '90' => 'Momentane Systemunterbrechung',
                    '91' => 'Kartenausgeber nicht erreichbar',
                    '96' => 'Fehlverhalten des Systems',
                    '94' => 'Kopierte Transaktion',
                    '97' => 'Fälligkeit der Verzögerung der globalen Überwachung',
                    '98' => 'Server nicht erreichbar, Routen des Netzwerkes erneut angefragt',
                    '99' => 'Vorfall der urhebenden Domain'
                ),
                'warranty_result' => array (
                    'empty' => 'Zahlungsgarantie nicht anwendbar',
                    'YES' => 'Die Zahlung ist garantiert',
                    'NO' => 'Die Zahlung ist nicht garantiert',
                    'UNKNOWN' => 'Die Zahlung kann aufgrund eines technischen Fehlers nicht gewährleistet werden'
                ),
                'risk_control' => array (
                    'CARD_FRAUD' => 'Card number control',
                    'SUSPECT_COUNTRY' => 'Card country control',
                    'IP_FRAUD' => 'IP address control',
                    'CREDIT_LIMIT' => 'Card outstanding control',
                    'BIN_FRAUD' => 'BIN code control',
                    'ECB' => 'E-carte bleue control',
                    'COMMERCIAL_CARD' => 'Commercial card control',
                    'SYSTEMATIC_AUTO' => 'Systematic authorization card control',
                    'INCONSISTENT_COUNTRIES' => 'Countries consistency control (IP, card, shipping address)',
                    'NON_WARRANTY_PAYMENT' => 'Transfer of responsibility control',
                    'SUSPECT_IP_COUNTRY' => 'IP country control'
                ),
                'risk_assessment' => array(
                    'ENABLE_3DS' => '3D Secure enabled',
                    'DISABLE_3DS' => '3D Secure disabled',
                    'MANUAL_VALIDATION' => 'The transaction has been created via manual validation',
                    'REFUSE' => 'The transaction is refused',
                    'RUN_RISK_ANALYSIS' => 'Call for an external risk analyser',
                    'INFORM' => 'A warning message appears'
                )
            )
        );

        public static $FORM_ERRORS = array(
            '00' => 'SIGNATURE',
            '01' => 'VERSION',
            '02' => 'SITE_ID',
            '03' => 'TRANS_ID',
            '04' => 'TRANS_DATE',
            '05' => 'VALIDATION_MODE',
            '06' => 'CAPTURE_DELAY',
            '07' => 'PAYMENT_CONFIG',
            '08' => 'PAYMENT_CARDS',
            '09' => 'AMOUNT',
            '10' => 'CURRENCY',
            '11' => 'CTX_MODE',
            '12' => 'LANGUAGE',
            '13' => 'ORDER_ID',
            '14' => 'ORDER_INFO',
            '15' => 'CUST_EMAIL',
            '16' => 'CUST_ID',
            '17' => 'CUST_TITLE',
            '18' => 'CUST_NAME',
            '19' => 'CUST_ADDRESS',
            '20' => 'CUST_ZIP',
            '21' => 'CUST_CITY',
            '22' => 'CUST_COUNTRY',
            '23' => 'CUST_PHONE',
            '24' => 'URL_SUCCESS',
            '25' => 'URL_REFUSED',
            '26' => 'URL_REFERRAL',
            '27' => 'URL_CANCEL',
            '28' => 'URL_RETURN',
            '29' => 'URL_ERROR',
            '30' => 'IDENTIFIER',
            '31' => 'CONTRIB',
            '32' => 'THEME_CONFIG',
            '33' => 'URL_CHECK',
            '34' => 'REDIRECT_SUCCESS_TIMEOUT',
            '35' => 'REDIRECT_SUCCESS_MESSAGE',
            '36' => 'REDIRECT_ERROR_TIMEOUT',
            '37' => 'REDIRECT_ERROR_MESSAGE',
            '38' => 'RETURN_POST_PARAMS',
            '39' => 'RETURN_GET_PARAMS',
            '40' => 'CARD_NUMBER',
            '41' => 'CARD_EXP_MONTH',
            '42' => 'CARD_EXP_YEAR',
            '43' => 'CARD_CVV',
            '44' => 'CARD_CVV_AND_BIRTH',
            '46' => 'PAGE_ACTION',
            '47' => 'ACTION_MODE',
            '48' => 'RETURN_MODE',
            '49' => 'ABSTRACT_INFO',
            '50' => 'SECURE_MPI',
            '51' => 'SECURE_ENROLLED',
            '52' => 'SECURE_CAVV',
            '53' => 'SECURE_ECI',
            '54' => 'SECURE_XID',
            '55' => 'SECURE_CAVV_ALG',
            '56' => 'SECURE_STATUS',
            '60' => 'PAYMENT_SRC',
            '61' => 'USER_INFO',
            '62' => 'CONTRACTS',
            '63' => 'RECURRENCE',
            '64' => 'RECURRENCE_DESC',
            '65' => 'RECURRENCE_AMOUNT',
            '66' => 'RECURRENCE_REDUCED_AMOUNT',
            '67' => 'RECURRENCE_CURRENCY',
            '68' => 'RECURRENCE_REDUCED_AMOUNT_NUMBER',
            '69' => 'RECURRENCE_EFFECT_DATE',
            '70' => 'EMPTY_PARAMS',
            '71' => 'AVAILABLE_LANGUAGES',
            '72' => 'SHOP_NAME',
            '73' => 'SHOP_URL',
            '74' => 'OP_COFINOGA',
            '75' => 'OP_CETELEM',
            '76' => 'BIRTH_DATE',
            '77' => 'CUST_CELL_PHONE',
            '79' => 'TOKEN_ID',
            '80' => 'SHIP_TO_NAME',
            '81' => 'SHIP_TO_STREET',
            '82' => 'SHIP_TO_STREET2',
            '83' => 'SHIP_TO_CITY',
            '84' => 'SHIP_TO_STATE',
            '85' => 'SHIP_TO_ZIP',
            '86' => 'SHIP_TO_COUNTRY',
            '87' => 'SHIP_TO_PHONE_NUM',
            '88' => 'CUST_STATE',
            '89' => 'REQUESTOR',
            '90' => 'PAYMENT_TYPE',
            '91' => 'EXT_INFO',
            '92' => 'CUST_STATUS',
            '93' => 'SHIP_TO_STATUS',
            '94' => 'SHIP_TO_TYPE',
            '95' => 'SHIP_TO_SPEED',
            '96' => 'SHIP_TO_DELIVERY_COMPANY_NAME',
            '97' => 'PRODUCT_LABEL',
            '98' => 'PRODUCT_TYPE',
            '100' => 'PRODUCT_REF',
            '101' => 'PRODUCT_QTY',
            '102' => 'PRODUCT_AMOUNT',
            '103' => 'PAYMENT_OPTION_CODE',
            '104' => 'CUST_FIRST_NAME',
            '105' => 'CUST_LAST_NAME',
            '106' => 'SHIP_TO_FIRST_NAME',
            '107' => 'SHIP_TO_LAST_NAME',
            '108' => 'TAX_AMOUNT',
            '109' => 'SHIPPING_AMOUNT',
            '110' => 'INSURANCE_AMOUNT',
            '111' => 'PAYMENT_ENTRY',
            '112' => 'CUST_ADDRESS_NUMBER',
            '113' => 'CUST_DISTRICT',
            '114' => 'SHIP_TO_STREET_NUMBER',
            '115' => 'SHIP_TO_DISTRICT',
            '116' => 'SHIP_TO_USER_INFO',
            '117' => 'RISK_PRIMARY_WARRANTY',
            '117' => 'DONATION',
            '99' => 'OTHER',
            '118' => 'STEP_UP_DATA',
            '201' => 'PAYMENT_AUTH_CODE',
            '202' => 'PAYMENT_CUST_CONTRACT_NUM',
            '888' => 'ROBOT_REQUEST',
            '999' => 'SENSITIVE_DATA'
        );
    }
}