sentence1
stringlengths 52
3.87M
| sentence2
stringlengths 1
47.2k
| label
stringclasses 1
value |
|---|---|---|
public function get($transactionId)
{
if ($transactionId <= 0) {
throw new HpsArgumentException('Invalid Transaction Id',HpsExceptionCodes::INVALID_ORIGINAL_TRANSACTION);
}
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsReportTxnDetail = $xml->createElement('hps:ReportTxnDetail');
$hpsReportTxnDetail->appendChild($xml->createElement('hps:TxnId', $transactionId));
$hpsTransaction->appendChild($hpsReportTxnDetail);
return $this->_submitTransaction($hpsTransaction, 'ReportTxnDetail');
}
|
@param $transactionId
@return array|null
@throws \HpsArgumentException
@throws \HpsException
@throws \HpsGatewayException
|
entailment
|
public function listTransactions($startDate, $endDate, $filterBy = null)
{
$this->_filterBy = $filterBy;
date_default_timezone_set("UTC");
$dateFormat = 'Y-m-d\TH:i:s.00\Z';
$current = new DateTime();
$currentTime = $current->format($dateFormat);
HpsInputValidation::checkDateNotFuture($startDate);
HpsInputValidation::checkDateNotFuture($endDate);
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsReportActivity = $xml->createElement('hps:ReportActivity');
$hpsReportActivity->appendChild($xml->createElement('hps:RptStartUtcDT', $startDate));
$hpsReportActivity->appendChild($xml->createElement('hps:RptEndUtcDT', $endDate));
$hpsTransaction->appendChild($hpsReportActivity);
return $this->_submitTransaction($hpsTransaction, 'ReportActivity');
}
|
@param $startDate
@param $endDate
@param null $filterBy
@return array|null
@throws \HpsException
@throws \HpsGatewayException
@throws \HpsInvalidRequestException
|
entailment
|
public function refund($amount, $currency, $cardData, $cardHolder = null, $details = null)
{
HpsInputValidation::checkCurrency($currency);
$this->_currency = $currency;
$this->_amount = HpsInputValidation::checkAmount($amount);
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditReturn = $xml->createElement('hps:CreditReturn');
$hpsBlock1 = $xml->createElement('hps:Block1');
$hpsBlock1->appendChild($xml->createElement('hps:AllowDup', 'Y'));
$hpsBlock1->appendChild($xml->createElement('hps:Amt', $amount));
if ($cardData instanceof HpsCreditCard) {
$cardDataElement = $xml->createElement('hps:CardData');
$cardDataElement->appendChild($this->_hydrateManualEntry($cardData, $xml));
$hpsBlock1->appendChild($cardDataElement);
} else if ($cardData instanceof HpsTokenData) {
$cardDataElement = $xml->createElement('hps:CardData');
$cardDataElement->appendChild($this->_hydrateTokenData($cardData, $xml));
$hpsBlock1->appendChild($cardDataElement);
} else {
$hpsBlock1->appendChild($xml->createElement('hps:GatewayTxnId', $cardData));
}
if ($cardHolder != null) {
$hpsBlock1->appendChild($this->_hydrateCardHolderData($cardHolder, $xml));
}
if ($details != null) {
$hpsBlock1->appendChild($this->_hydrateAdditionalTxnFields($details, $xml));
}
$hpsCreditReturn->appendChild($hpsBlock1);
$hpsTransaction->appendChild($hpsCreditReturn);
return $this->_submitTransaction($hpsTransaction, 'CreditReturn', (isset($details->clientTransactionId) ? $details->clientTransationId : null));
}
|
@param $amount
@param $currency
@param $cardData
@param null $cardHolder
@param null $details
@return array|null
@throws \HpsException
@throws \HpsGatewayException
@throws \HpsInvalidRequestException
|
entailment
|
public function verify($cardOrToken, $cardHolder = null, $requestMultiUseToken = false, $clientTransactionId = null)
{
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditAccountVerify = $xml->createElement('hps:CreditAccountVerify');
$hpsBlock1 = $xml->createElement('hps:Block1');
if ($cardHolder != null) {
$hpsBlock1->appendChild($this->_hydrateCardHolderData($cardHolder, $xml));
}
$cardData = $xml->createElement('hps:CardData');
if ($cardOrToken instanceof HpsCreditCard) {
$cardData->appendChild($this->_hydrateManualEntry($cardOrToken, $xml));
} else {
$cardData->appendChild($this->_hydrateTokenData($cardOrToken, $xml));
}
$cardData->appendChild($xml->createElement('hps:TokenRequest', ($requestMultiUseToken) ? 'Y' : 'N'));
$hpsBlock1->appendChild($cardData);
$hpsCreditAccountVerify->appendChild($hpsBlock1);
$hpsTransaction->appendChild($hpsCreditAccountVerify);
return $this->_submitTransaction($hpsTransaction, 'CreditAccountVerify', $clientTransactionId);
}
|
@param $cardOrToken
@param null $cardHolder
@param bool $requestMultiUseToken
@param null $clientTransactionId
@return array|null
@throws \HpsException
@throws \HpsGatewayException
|
entailment
|
public function void($transactionId, $clientTransactionId = null)
{
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditVoid = $xml->createElement('hps:CreditVoid');
$hpsCreditVoid->appendChild($xml->createElement('hps:GatewayTxnId', $transactionId));
$hpsTransaction->appendChild($hpsCreditVoid);
return $this->_submitTransaction($hpsTransaction, 'CreditVoid', $clientTransactionId);
}
|
@param $transactionId
@param null $clientTransactionId
@return array|null
@throws \HpsException
@throws \HpsGatewayException
|
entailment
|
private function _processChargeGatewayResponse($response, $expectedType)
{
$gatewayRspCode = (isset($response->Header->GatewayRspCode) ? $response->Header->GatewayRspCode : null);
$transactionId = (isset($response->Header->GatewayTxnId) ? $response->Header->GatewayTxnId : null);
if ($gatewayRspCode == '0') {
return;
}
if ($gatewayRspCode == '30') {
try {
$this->reverse($transactionId, $this->_amount, $this->_currency);
} catch (Exception $e) {
throw new HpsGatewayException(
HpsExceptionCodes::GATEWAY_TIMEOUT_REVERSAL_ERROR,
'Error occurred while reversing a charge due to HPS gateway timeout',
$e,
null,
null,
$transactionId
);
}
}
HpsGatewayResponseValidation::checkResponse($response, $expectedType);
}
|
@param $response
@param $expectedType
@throws \HpsAuthenticationException
@throws \HpsGatewayException
@throws null
|
entailment
|
private function _processChargeIssuerResponse($response, $expectedType)
{
$transactionId = (isset($response->Header->GatewayTxnId) ? $response->Header->GatewayTxnId : null);
$item = $response->Transaction->$expectedType;
if ($item != null) {
$responseCode = (isset($item->RspCode) ? $item->RspCode : null);
$responseText = (isset($item->RspText) ? $item->RspText : null);
if ($responseCode != null) {
// check if we need to do a reversal
if ($responseCode == '91') {
try {
$this->reverse($transactionId, $this->_amount, $this->_currency);
} catch (HpsGatewayException $e) {
// if the transaction wasn't found; throw the original timeout exception
if ($e->details->gatewayResponseCode == 3) {
HpsIssuerResponseValidation::checkResponse($transactionId, $responseCode, $responseText);
}
throw new HpsCreditException(
$transactionId,
HpsExceptionCodes::ISSUER_TIMEOUT_REVERSAL_ERROR,
'Error occurred while reversing a charge due to HPS issuer timeout',
$e
);
} catch (HpsException $e) {
throw new HpsCreditException(
$transactionId,
HpsExceptionCodes::ISSUER_TIMEOUT_REVERSAL_ERROR,
'Error occurred while reversing a charge due to HPS issuer timeout',
$e
);
}
}
HpsIssuerResponseValidation::checkResponse($transactionId, $responseCode, $responseText);
}
}
}
|
@param $response
@param $expectedType
@throws \HpsCreditException
@throws null
|
entailment
|
private function _submitTransaction($transaction, $txnType, $clientTxnId = null, $cardData = null)
{
$options = array();
if ($clientTxnId != null) {
$options['clientTransactionId'] = $clientTxnId;
}
try {
$response = $this->doRequest($transaction, $options);
} catch (HpsException $e) {
if ($e->innerException != null && $e->innerException->getMessage() == 'gateway_time-out') {
if (in_array($txnType, array('CreditSale', 'CreditAuth'))) {
try {
$this->reverse($cardData, $this->_amount, $this->_currency);
} catch (Exception $e) {
throw new HpsGatewayException('0', HpsExceptionCodes::GATEWAY_TIMEOUT_REVERSAL_ERROR);
}
}
throw new HpsException('An error occurred and the gateway has timed out', 'gateway_timeout', $e, 'gateway_timeout');
}
throw $e;
}
$this->_processChargeGatewayResponse($response, $txnType);
$this->_processChargeIssuerResponse($response, $txnType);
$rvalue = null;
switch ($txnType) {
case 'ReportTxnDetail':
$rvalue = HpsReportTransactionDetails::fromDict($response, $txnType);
break;
case 'ReportActivity':
$rvalue = HpsReportTransactionSummary::fromDict($response, $txnType, $this->_filterBy);
break;
case 'CreditSale':
$rvalue = HpsCharge::fromDict($response, $txnType);
break;
case 'CreditAccountVerify':
$rvalue = HpsAccountVerify::fromDict($response, $txnType);
break;
case 'CreditAuth':
$rvalue = HpsAuthorization::fromDict($response, $txnType);
break;
case 'CreditReturn':
$rvalue = HpsRefund::fromDict($response, $txnType);
break;
case 'CreditReversal':
$rvalue = HpsReversal::fromDict($response, $txnType);
break;
case 'CreditVoid':
$rvalue = HpsVoid::fromDict($response, $txnType);
break;
case 'CreditCPCEdit':
$rvalue = HpsCPCEdit::fromDict($response, $txnType);
break;
case 'CreditTxnEdit':
$rvalue = HpsTransaction::fromDict($response, $txnType);
break;
case 'RecurringBilling':
$rvalue = HpsRecurringBilling::fromDict($response, $txnType);
break;
case 'ManageTokens':
$rvalue = HpsManageTokensResponse::fromDict($response);
break;
default:
break;
}
return $rvalue;
}
|
@param $transaction
@param $txnType
@param null $clientTxnId
@param null $cardData
@return array|null
@throws \HpsCreditException
@throws \HpsException
@throws \HpsGatewayException
|
entailment
|
public function execute()
{
parent::execute();
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditOfflineAuth = $xml->createElement('hps:CreditOfflineAuth');
$hpsBlock1 = $xml->createElement('hps:Block1');
$hpsBlock1->appendChild($xml->createElement('hps:AllowDup', ($this->allowDuplicates ? 'Y' : 'N')));
$hpsBlock1->appendChild($xml->createElement('hps:Amt', $this->amount));
//update convenienceAmtInfo if passed
if ($this->convenienceAmtInfo != null && $this->convenienceAmtInfo != '') {
$hpsBlock1->appendChild($xml->createElement('hps:ConvenienceAmtInfo', HpsInputValidation::checkAmount($this->convenienceAmtInfo)));
}
//update shippingAmtInfo if passed
if ($this->shippingAmtInfo != null && $this->shippingAmtInfo != '') {
$hpsBlock1->appendChild($xml->createElement('hps:ShippingAmtInfo', HpsInputValidation::checkAmount($this->shippingAmtInfo)));
}
if ($this->gratuity != null) {
$hpsBlock1->appendChild($xml->createElement('hps:GratuityAmtInfo', $this->gratuity));
}
if ($this->cardHolder != null) {
$hpsBlock1->appendChild($this->service->_hydrateCardHolderData($this->cardHolder, $xml));
}
$cardData = $xml->createElement('hps:CardData');
if ($this->card != null) {
$cardData->appendChild($this->service->_hydrateManualEntry(
$this->card,
$xml,
$this->cardPresent,
$this->readerPresent
));
if ($this->card->encryptionData != null) {
$cardData->appendChild($this->service->_hydrateEncryptionData($this->card->encryptionData));
}
} else if ($this->token != null) {
$cardData->appendChild($this->service->_hydrateTokenData(
$this->token,
$xml,
$this->cardPresent,
$this->readerPresent
));
} else if ($this->trackData != null) {
$cardData->appendChild($this->service->_hydrateTrackData($this->trackData, $xml));
if ($this->trackData->encryptionData != null) {
$cardData->appendChild($this->service->_hydrateEncryptionData($this->trackData->encryptionData));
}
} else if ($this->paymentData != null) {
$manualEntry = $xml->createElement('hps:ManualEntry');
$manualEntry->appendChild($xml->createElement('hps:CardNbr', $this->paymentData->applicationPrimaryAccountNumber));
$expDate = (string)$this->paymentData->applicationExpirationDate;
$manualEntry->appendChild($xml->createElement('hps:ExpMonth', substr($expDate, 2, 2)));
$manualEntry->appendChild($xml->createElement('hps:ExpYear', '20'.substr($expDate, 0, 2)));
$cardData->appendChild($manualEntry);
}
$cardData->appendChild($xml->createElement('hps:TokenRequest', ($this->requestMultiUseToken ? 'Y' : 'N')));
$hpsBlock1->appendChild($cardData);
if ($this->paymentData != null) {
$hpsBlock1->appendChild($this->service->_hydrateSecureEcommerce($this->paymentData->paymentData));
}
if ($this->cpcReq == true) {
$hpsBlock1->appendChild($xml->createElement('hps:CPCReq', 'Y'));
}
if ($this->txnDescriptor != null) {
$hpsBlock1->appendChild($xml->createElement('hps:TxnDescriptor', $this->txnDescriptor));
}
if ($this->autoSubstantiation != null) {
$hpsBlock1->appendChild($this->service->_hydrateAutoSubstantiation($this->autoSubstantiation));
}
if ($this->offlineAuthCode != null) {
$hpsBlock1->appendChild($xml->createElement('hps:OfflineAuthCode', $this->offlineAuthCode));
}
$hpsCreditOfflineAuth->appendChild($hpsBlock1);
$hpsTransaction->appendChild($hpsCreditOfflineAuth);
return $this->service->_submitTransaction($hpsTransaction, 'CreditOfflineAuth', (isset($this->details->clientTransactionId) ? $this->details->clientTransactionId : null));
}
|
Creates a offline charge transaction through the HpsCreditService
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsAltPaymentResponse')
{
$response = $rsp->Transaction->$txnType;
$altPayment = parent::fromDict($rsp, $txnType, $returnType);
if ($response->RspCode != 0) {
$error = self::nvpToArray($response->Processor->Response);
$altPayment->error = new HpsProcessorError();
$altPayment->error->code = isset($error['Code']) ? $error['Code'] : null;
$altPayment->error->message = isset($error['Message']) ? $error['Message'] : null;
$altPayment->error->type = isset($error['Type']) ? $error['Type'] : null;
}
return $altPayment;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public function execute()
{
parent::execute();
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditAuth = $xml->createElement('hps:PrePaidAddValue');
$hpsBlock1 = $xml->createElement('hps:Block1');
$hpsBlock1->appendChild($xml->createElement('hps:Amt', $this->amount));
$hpsBlock1->appendChild($xml->createElement('hps:AllowDup', ($this->allowDuplicates ? 'Y' : 'N')));
$cardData = $xml->createElement('hps:CardData');
if ($this->card != null) {
$cardData->appendChild($this->service->_hydrateManualEntry($this->card, $xml));
} else if ($this->trackData != null) {
$cardData->appendChild($this->service->_hydrateTrackData($this->trackData, $xml));
} else if ($this->token != null) {
$cardData->appendChild($this->service->_hydrateTokenData($this->token, $xml));
}
$hpsBlock1->appendChild($cardData);
$hpsCreditAuth->appendChild($hpsBlock1);
$hpsTransaction->appendChild($hpsCreditAuth);
return $this->service->_submitTransaction($hpsTransaction, 'PrePaidAddValue');
}
|
Creates an add value transaction through the HpsCreditService
|
entailment
|
public function onlyOnePaymentMethod($actionCounts)
{
$methods = 0;
if (isset($actionCounts['card']) && $actionCounts['card'] == 1) {
$methods++;
}
if (isset($actionCounts['token']) && $actionCounts['token'] == 1) {
$methods++;
}
if (isset($actionCounts['trackData']) && $actionCounts['trackData'] == 1) {
$methods++;
}
return $methods == 1;
}
|
Ensures there is only one payment method, and checks that
there is only one card or one token in use. Both cannot be
used.
@param array $actionCounts
@return bool
|
entailment
|
public function getToken(HpsCreditCard $cardData)
{
$data = array();
$data['api_key'] = $this->_config->publicApiKey;
$data['object'] = 'token';
$data['token_type'] = 'supt';
$data['_method'] = 'post';
$data['card[number]'] = $cardData->number;
$data['card[cvc]'] = $cardData->cvv;
$data['card[exp_month]'] = $cardData->expMonth;
$data['card[exp_year]'] = $cardData->expYear;
$url = $this->_url ."?". http_build_query($data);
$header = array('Content-type: application/json');
return $this->submitRequest($url, $header, null, 'GET', HpsServicesConfig::KEY_TYPE_PUBLIC);
}
|
@param \HpsCreditCard $cardData
@return mixed
@throws \HpsAuthenticationException
@throws \HpsGatewayException
|
entailment
|
public function getGiftCardToken(HpsGiftCard $cardData)
{
$data = array();
$data['api_key'] = $this->_config->publicApiKey;
$data['object'] = 'token';
$data['token_type'] = 'supt';
$data['_method'] = 'post';
$data['card[number]'] = $cardData->number;
$url = $this->_url ."?". http_build_query($data);
$header = array('Content-type: application/json');
return $this->submitRequest($url, $header, null, 'GET', HpsServicesConfig::KEY_TYPE_PUBLIC);
}
|
@param \HpsGiftCard $cardData
@return mixed
@throws \HpsAuthenticationException
@throws \HpsGatewayException
|
entailment
|
protected function processResponse($curlResponse, $curlInfo, $curlError)
{
$response = json_decode($curlResponse);
if (isset($response->error) && is_object($response->error)) {
throw new HpsException($response->error->message, $response->error->code);
}
return $response;
}
|
@param $curlResponse
@param $curlInfo
@param $curlError
@return mixed
@throws \HpsException
|
entailment
|
public function execute()
{
parent::execute();
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditAccountVerify = $xml->createElement('hps:CreditAccountVerify');
$hpsBlock1 = $xml->createElement('hps:Block1');
if ($this->cardHolder != null) {
$hpsBlock1->appendChild($this->service->_hydrateCardHolderData($this->cardHolder, $xml));
}
$cardData = $xml->createElement('hps:CardData');
if ($this->card != null) {
$cardData->appendChild($this->service->_hydrateManualEntry(
$this->card,
$xml,
$this->cardPresent,
$this->readerPresent
));
if ($this->card->encryptionData != null) {
$cardData->appendChild($this->service->_hydrateEncryptionData(
$this->card->encryptionData,
$xml
));
}
} else if ($this->token != null) {
$cardData->appendChild($this->service->_hydrateTokenData(
$this->token,
$xml,
$this->cardPresent,
$this->readerPresent
));
} else if ($this->trackData != null) {
$cardData->appendChild($this->service->_hydrateTrackData($this->trackData, $xml));
if ($this->trackData->encryptionData != null) {
$cardData->appendChild($this->service->_hydrateEncryptionData(
$this->trackData->encryptionData,
$xml
));
}
}
$cardData->appendChild($xml->createElement('hps:TokenRequest', ($this->requestMultiUseToken) ? 'Y' : 'N'));
$hpsBlock1->appendChild($cardData);
$hpsCreditAccountVerify->appendChild($hpsBlock1);
$hpsTransaction->appendChild($hpsCreditAccountVerify);
return $this->service->_submitTransaction($hpsTransaction, 'CreditAccountVerify', $this->clientTransactionId);
}
|
Creates a verify transaction through the HpsCreditService
|
entailment
|
public function onlyOnePaymentMethod($actionCounts)
{
$count = 0;
if (isset($actionCounts['card'])) { $count++; }
if (isset($actionCounts['token'])) { $count++; }
if (isset($actionCounts['trackData'])) { $count++; }
return 1 === $count;
}
|
Ensures there is only one payment method, and checks that
there is only one card or one token in use. Both cannot be
used.
@param array $actionCounts
@return bool
|
entailment
|
public static function fromObject($data, $returnType = 'HpsCardinalMPILookupResponse')
{
$response = parent::fromObject($data, $returnType);
$response->acsUrl = self::readDataKey($data, 'ACSUrl');
$response->enrolled = self::readDataKey($data, 'Enrolled');
$response->payload = self::readDataKey($data, 'Payload');
$response->processorTransactionIdPairing = self::readDataKey($data, 'ProcessorTransactionIdPairing');
return $response;
}
|
@param $data
@param string $returnType
@return mixed
|
entailment
|
public function extractMeaning($query, $extraParams = [])
{
$query = array_merge($extraParams, [
'lang' => $this->client->getApiLanguage(),
'query' => $query,
]);
$response = $this->client->post('query', $query);
return $this->decodeResponse($response);
}
|
@param string $query
@param array $extraParams
@return mixed
|
entailment
|
public function extractMeaningAsync($query, $extraParams = [])
{
$query = array_merge($extraParams, [
'lang' => $this->client->getApiLanguage(),
'query' => $query,
]);
return $this->client->postAsync('query', $query)->then([$this, 'decodeResponse']);
}
|
@param $query
@param array $extraParams
@return PromiseInterface
|
entailment
|
public function execute()
{
parent::execute();
$replaceSvc = new HpsGiftCardService($this->service->servicesConfig());
return $replaceSvc->replace(
$this->oldCard,
$this->newCard
);
}
|
Creates a replace transaction through the HpsGiftCardService
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsTransactionStatus')
{
$statusResponse = $rsp->Transaction->$txnType;
$status = parent::fromDict($rsp, $txnType, $returnType);
$status->authorizationCode = (isset($statusResponse->TransactionStatus->AuthCode) ? (string)$statusResponse->TransactionStatus->AuthCode : null);
$status->originalGatewayResponseCode = (isset($statusResponse->TransactionStatus->GatewayRspCode) ? (string)$statusResponse->TransactionStatus->GatewayRspCode : null);
$status->originalGatewayResponseText = (isset($statusResponse->TransactionStatus->GatewayRspMsg) ? (string)$statusResponse->TransactionStatus->GatewayRspMsg : null);
$status->originalResponseCode = (isset($statusResponse->TransactionStatus->RspCode) ? (string)$statusResponse->TransactionStatus->RspCode : null);
$status->originalResponseText = (isset($statusResponse->TransactionStatus->RspText) ? (string)$statusResponse->TransactionStatus->RspText : null);
$status->transactionStatus = (isset($statusResponse->TransactionStatus->TxnStatus) ? (string)$statusResponse->TransactionStatus->TxnStatus : null);
$status->originalTransactionId = (isset($statusResponse->TransactionStatus->GatewayTxnId) ? (string)$statusResponse->TransactionStatus->GatewayTxnId : null);
$status->altPayment = (isset($statusResponse->TransactionStatus->AltPayment) ? $statusResponse->TransactionStatus->AltPayment : null);
$status->timezoneConversion = (isset($statusResponse->TzConversion) ? (string)$statusResponse->TzConversion : null);
return $status;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsRefund')
{
$refund = parent::fromDict($rsp, $txnType, $returnType);
$refund->responseCode = '00';
$refund->responseText = '';
return $refund;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public function execute()
{
parent::execute();
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsCreditVoid = $xml->createElement('hps:CreditVoid');
$hpsCreditVoid->appendChild($xml->createElement('hps:GatewayTxnId', $this->transactionId));
$hpsTransaction->appendChild($hpsCreditVoid);
return $this->service->_submitTransaction($hpsTransaction, 'CreditVoid', $this->clientTransactionId);
}
|
Creates a void transaction through the HpsCreditService
|
entailment
|
public function create($sessionId, $message, $contexts = [])
{
try {
$step = $this->getStep($sessionId, $message, $contexts);
} catch (\Exception $error) {
return $this->actionMapping->error($sessionId, $error);
}
return $this->performStep($sessionId, $step);
}
|
@param string $sessionId
@param string $message
@param array $contexts
@return bool|void
|
entailment
|
private function getStep($sessionId, $message, $contexts = [])
{
$query = $this->queryApi->extractMeaning($message, [
'sessionId' => $sessionId,
'contexts' => $contexts,
]);
$query = new Query($query);
if (null === $query) {
$query = new Query();
}
if ($query->getStatus()->getCode() !== 200) {
throw new DialogException($query->getStatus()->getErrorDetails(), $sessionId, $query);
}
try {
$step = StepFactory::create($query);
} catch (InvalidStepException $error) {
throw new DialogException($error->getMessage(), $sessionId, $error->getQuery());
}
return $step;
}
|
@param string $sessionId
@param string $message
@param array $contexts
@return Action|Speech
|
entailment
|
private function performStep($sessionId, Step $step)
{
switch (true) {
case $step instanceof Action:
return $this->actionMapping->action($sessionId, $step->getAction(), $step->getParameters(), $step->getContexts());
break;
case $step instanceof Speech:
return $this->actionMapping->speech($sessionId, $step->getSpeech(), $step->getContexts());
break;
}
return false;
}
|
@param string $sessionId
@param Step $step
@return bool
|
entailment
|
public function validate($keyType)
{
return ($keyType == self::KEY_TYPE_PUBLIC && $this->validatePublicApiKey())
|| ($keyType == self::KEY_TYPE_SECRET && $this->validateSecretApiKey());
}
|
@param $keyType
@return bool
|
entailment
|
public function getKeyType($keyType)
{
$key = trim($keyType == self::KEY_TYPE_SECRET ? $this->secretApiKey : $this->publicApiKey);
switch (true) {
case substr($key, 0, 6) == 'skapi_':
return self::KEY_TYPE_SECRET;
break;
case substr($key, 0, 6) == 'pkapi_':
return self::KEY_TYPE_PUBLIC;
break;
default:
return self::KEY_TYPE_UNKNOWN;
break;
}
}
|
@param $keyType
@return string
|
entailment
|
public function execute()
{
parent::execute();
$addValueSvc = new HpsDebitService($this->service->servicesConfig());
return $addValueSvc->addValue(
$this->amount,
$this->currency,
$this->trackData,
$this->pinBlock,
$this->encryptionData,
$this->allowDuplicates,
$this->cardHolder,
$this->details,
$this->clientTransactionId
);
}
|
Creates a addValue transaction through the HpsDebitService
|
entailment
|
private function setUpValidations()
{
$this
->addValidation(array($this, 'amountNotNull'), 'HpsArgumentException', 'AddValue needs an amount')
->addValidation(array($this, 'currencyNotNull'), 'HpsArgumentException', 'AddValue needs an currency')
->addValidation(array($this, 'trackDataNotNull'), 'HpsArgumentException', 'AddValue needs an trackData')
->addValidation(array($this, 'pinBlockNotNull'), 'HpsArgumentException', 'AddValue needs an pinBlock');
}
|
Setups up validations for building addValues.
@return null
|
entailment
|
public function doRequest($request, $options = null)
{
$request = array_merge($request, array(
'Version' => $this->_config->version,
'ProcessorId' => $this->_config->processorId,
'MerchantId' => $this->_config->merchantId,
'TransactionPwd' => $this->_config->transactionPwd,
));
$xml = new DOMDocument('1.0', 'utf-8');
$envelope = $xml->createElement('CardinalMPI');
foreach ($request as $k => $v) {
$envelope->appendChild($xml->createElement($k, $v));
}
$xml->appendChild($envelope);
$url = $this->_config->serviceUri();
$xmlData = $xml->saveXML();
$data = 'cmpi_msg=' . urlencode($xmlData);
$header = array(
'Content-type: application/x-www-form-urlencoded;charset="utf-8"',
'Accept: text/xml',
'Content-length: '.strlen($data),
);
// error_log($xmlData);
return $this->submitRequest($url, $header, $data);
}
|
@param $request
@param null $options
@return mixed
@throws \HpsAuthenticationException
@throws \HpsGatewayException
|
entailment
|
public function processResponse($curlResponse, $curlInfo, $curlError)
{
// error_log($curlResponse);
switch ($curlInfo['http_code']) {
case '200':
return simplexml_load_string($curlResponse);
break;
case '500':
$faultString = '';
throw new HpsException($faultString);
break;
default:
throw new HpsException('Unexpected response');
break;
}
}
|
@param $curlResponse
@param $curlInfo
@param $curlError
@return \SimpleXMLElement
@throws \HpsException
|
entailment
|
public function doRequest($transaction, $options = array())
{
$xml = new DOMDocument('1.0', 'utf-8');
$soapEnvelope = $xml->createElement('soapenv:Envelope');
$soapEnvelope->setAttribute('xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/');
$soapEnvelope->setAttribute('xmlns:hps', 'http://Hps.Exchange.PosGateway');
$soapBody = $xml->createElement('soapenv:Body');
$hpsRequest = $xml->createElement('hps:PosRequest');
$hpsVersion = $xml->createElement('hps:Ver1.0');
$hpsHeader = $xml->createElement('hps:Header');
if ($this->_config->secretApiKey != null && $this->_config->secretApiKey != "") {
$hpsHeader->appendChild($xml->createElement('hps:SecretAPIKey', trim($this->_config->secretApiKey)));
} else {
$hpsHeader->appendChild($xml->createElement('hps:SiteId', $this->_config->siteId));
$hpsHeader->appendChild($xml->createElement('hps:DeviceId', $this->_config->deviceId));
$hpsHeader->appendChild($xml->createElement('hps:LicenseId', $this->_config->licenseId));
$hpsHeader->appendChild($xml->createElement('hps:UserName', $this->_config->username));
$hpsHeader->appendChild($xml->createElement('hps:Password', $this->_config->password));
}
if ($this->_config->developerId != null && $this->_config->developerId != "") {
$hpsHeader->appendChild($xml->createElement('hps:DeveloperID', $this->_config->developerId));
$hpsHeader->appendChild($xml->createElement('hps:VersionNbr', $this->_config->versionNumber));
$hpsHeader->appendChild($xml->createElement('hps:SiteTrace', $this->_config->siteTrace));
}
if (isset($options['clientTransactionId'])) {
$hpsHeader->appendChild($xml->createElement('hps:ClientTxnId', $options['clientTransactionId']));
}
$hpsVersion->appendChild($hpsHeader);
$transaction = $xml->importNode($transaction, true);
$hpsVersion->appendChild($transaction);
$hpsRequest->appendChild($hpsVersion);
$soapBody->appendChild($hpsRequest);
$soapEnvelope->appendChild($soapBody);
$xml->appendChild($soapEnvelope);
$url = $this->_gatewayUrlForKey();
$header = array(
'Content-type: text/xml;charset="utf-8"',
'Accept: text/xml',
'SOAPAction: ""',
'Content-length: '.strlen($xml->saveXML()),
);
$data = $xml->saveXML();
// print "\n" . $data;
return $this->submitRequest($url, $header, $data);
}
|
@param $transaction
@param array $options
@return mixed
@throws \HpsAuthenticationException
@throws \HpsGatewayException
|
entailment
|
public function processResponse($curlResponse, $curlInfo, $curlError)
{
// print "\n" . $curlResponse;
switch ($curlInfo['http_code']) {
case '200':
$responseObject = $this->_XML2Array($curlResponse);
$ver = "Ver1.0";
return $responseObject->$ver;
break;
case '500':
$faultString = $this->_XMLFault2String($curlResponse);
throw new HpsException($faultString);
break;
default:
throw new HpsException('Unexpected response');
break;
}
}
|
@param $curlResponse
@param $curlInfo
@param $curlError
@return mixed
@throws \HpsException
|
entailment
|
public function _hydrateAdditionalTxnFields($details, DOMDocument $xml)
{
$additionalTxnFields = $xml->createElement('hps:AdditionalTxnFields');
if ($details->memo != null && $details->memo != "") {
$additionalTxnFields->appendChild($xml->createElement('hps:Description', $details->memo));
}
if ($details->invoiceNumber != null && $details->invoiceNumber != "") {
$additionalTxnFields->appendChild($xml->createElement('hps:InvoiceNbr', $details->invoiceNumber));
}
if ($details->customerId != null && $details->customerId != "") {
$additionalTxnFields->appendChild($xml->createElement('hps:CustomerID', $details->customerId));
}
return $additionalTxnFields;
}
|
@param $details
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateCardHolderData(HpsCardHolder $cardHolder, DOMDocument $xml)
{
//handle both phone and phoneNumber properties as a valid phone
if($cardHolder->phone === null && !empty($cardHolder->phoneNumber) === true){
$cardHolder->phone = $cardHolder->phoneNumber;
}
//handle both email and emailAddress properties as a valid email
if($cardHolder->email === null && !empty($cardHolder->emailAddress) === true){
$cardHolder->email = $cardHolder->emailAddress;
}
$cardHolderData = $xml->createElement('hps:CardHolderData');
$cardHolderData->appendChild($xml->createElement('hps:CardHolderFirstName', HpsInputValidation::checkCardHolderData($cardHolder->firstName, 'FirstName')));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderLastName', HpsInputValidation::checkCardHolderData($cardHolder->lastName,'LastName')));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderEmail', HpsInputValidation::checkEmailAddress($cardHolder->email)));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderPhone', HpsInputValidation::checkPhoneNumber($cardHolder->phone)));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderAddr', HpsInputValidation::checkCardHolderData($cardHolder->address->address)));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderCity', HpsInputValidation::checkCardHolderData($cardHolder->address->city, 'City')));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderState', HpsInputValidation::checkCardHolderData($cardHolder->address->state, 'State')));
$cardHolderData->appendChild($xml->createElement('hps:CardHolderZip', HpsInputValidation::checkZipCode($cardHolder->address->zip)));
return $cardHolderData;
}
|
@param \HpsCardHolder $cardHolder
@param \DOMDocument $xml
@return \DOMElement
@throws \HpsInvalidRequestException
|
entailment
|
public function _hydrateCheckData(HpsCheck $check, DOMDocument $xml)
{
$checkData = $xml->createElement('hps:AccountInfo');
if ($check->accountNumber != null) {
$checkData->appendChild($xml->createElement('hps:AccountNumber', $check->accountNumber));
}
if ($check->checkNumber != null) {
$checkData->appendChild($xml->createElement('hps:CheckNumber', $check->checkNumber));
}
if ($check->micrNumber != null) {
$checkData->appendChild($xml->createElement('hps:MICRData', $check->micrNumber));
}
if ($check->routingNumber != null) {
$checkData->appendChild($xml->createElement('hps:RoutingNumber', $check->routingNumber));
}
if ($check->accountType != null) {
$checkData->appendChild($xml->createElement('hps:AccountType', strtoupper($check->accountType)));
}
return $checkData;
}
|
@param \HpsCheck $check
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateConsumerInfo(HpsCheck $check, DOMDocument $xml)
{
$consumerInfo = $xml->createElement('hps:ConsumerInfo');
if ($check->checkHolder->address != null) {
$consumerInfo->appendChild($xml->createElement('hps:Address1', $check->checkHolder->address->address));
$consumerInfo->appendChild($xml->createElement('hps:City', $check->checkHolder->address->city));
$consumerInfo->appendChild($xml->createElement('hps:State', $check->checkHolder->address->state));
$consumerInfo->appendChild($xml->createElement('hps:Zip', $check->checkHolder->address->zip));
}
if ($check->checkHolder->checkName != null) {
$consumerInfo->appendChild($xml->createElement('hps:CheckName', $check->checkHolder->checkName));
}
if ($check->checkHolder->courtesyCard != null) {
$consumerInfo->appendChild($xml->createElement('hps:CourtesyCard', $check->checkHolder->courtesyCard));
}
if ($check->checkHolder->dlNumber != null) {
$consumerInfo->appendChild($xml->createElement('hps:DLNumber', $check->checkHolder->dlNumber));
}
if ($check->checkHolder->dlState != null) {
$consumerInfo->appendChild($xml->createElement('hps:DLState', $check->checkHolder->dlState));
}
if ($check->checkHolder->email != null) {
$consumerInfo->appendChild($xml->createElement('hps:EmailAddress', $check->checkHolder->email));
}
if ($check->checkHolder->firstName != null) {
$consumerInfo->appendChild($xml->createElement('hps:FirstName', $check->checkHolder->firstName));
}
if ($check->checkHolder->lastName != null) {
$consumerInfo->appendChild($xml->createElement('hps:LastName', $check->checkHolder->lastName));
}
if ($check->checkHolder->phone != null) {
$consumerInfo->appendChild($xml->createElement('hps:PhoneNumber', $check->checkHolder->phone));
}
if ($check->checkHolder->ssl4 != null || $check->checkHolder->dobYear != null) {
$identityInfo = $xml->createElement('hps:IdentityInfo');
if ($check->checkHolder->ssl4 != null) {
$identityInfo->appendChild($xml->createElement('hps:SSNL4', $check->checkHolder->ssl4));
}
if ($check->checkHolder->dobYear != null) {
$identityInfo->appendChild($xml->createElement('hps:DOBYear', $check->checkHolder->dobYear));
}
$consumerInfo->appendChild($identityInfo);
}
return $consumerInfo;
}
|
@param \HpsCheck $check
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateCPCData(HpsCPCData $cpcData, DOMDocument $xml)
{
$cpcDataElement = $xml->createElement('hps:CPCData');
if (isset($cpcData->cardHolderPONbr)) {
$cpcDataElement->appendChild($xml->createElement('hps:CardHolderPONbr', $cpcData->cardHolderPONbr));
}
if (isset($cpcData->taxAmt)) {
$cpcDataElement->appendChild($xml->createElement('hps:TaxAmt', $cpcData->taxAmt));
}
if (isset($cpcData->taxType)) {
$cpcDataElement->appendChild($xml->createElement('hps:TaxType', $cpcData->taxType));
}
return $cpcDataElement;
}
|
@param \HpsCPCData $cpcData
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateDirectMarketData(HpsDirectMarketData $data, DOMDocument $xml)
{
$directMktDataElement = $xml->createElement('hps:DirectMktData');
$directMktDataElement->appendChild($xml->createElement('hps:DirectMktInvoiceNbr', $data->invoiceNumber));
$directMktDataElement->appendChild($xml->createElement('hps:DirectMktShipMonth', $data->shipMonth));
$directMktDataElement->appendChild($xml->createElement('hps:DirectMktShipDay', $data->shipDay));
return $directMktDataElement;
}
|
@param \HpsDirectMarketData $data
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateEncryptionData(HpsEncryptionData $encryptionData, DOMDocument $xml)
{
$encData = $xml->createElement('hps:EncryptionData');
if ($encryptionData->encryptedTrackNumber != null) {
$encData->appendChild($xml->createElement('hps:EncryptedTrackNumber', $encryptionData->encryptedTrackNumber));
}
$encData->appendChild($xml->createElement('hps:KSN', $encryptionData->ksn));
$encData->appendChild($xml->createElement('hps:KTB', $encryptionData->ktb));
$encData->appendChild($xml->createElement('hps:Version', $encryptionData->version));
return $encData;
}
|
@param \HpsEncryptionData $encryptionData
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
public function _hydrateGiftCardData(HpsGiftCard $giftCard, DOMDocument $xml, $elementName = 'CardData')
{
$giftCardData = $xml->createElement('hps:'.$elementName);
if ($giftCard->number != null) {
$giftCardData->appendChild($xml->createElement('hps:CardNbr', $giftCard->number));
} else if ($giftCard->trackData != null) {
$giftCardData->appendChild($xml->createElement('hps:TrackData', $giftCard->trackData));
} else if ($giftCard->alias != null) {
$giftCardData->appendChild($xml->createElement('hps:Alias', $giftCard->alias));
} else if ($giftCard->tokenValue != null) {
$giftCardData->appendChild($xml->createElement('hps:TokenValue', $giftCard->tokenValue));
}
if ($giftCard->encryptionData != null) {
$giftCardData->appendChild($this->_hydrateEncryptionData($giftCard->encryptionData, $xml));
}
if ($giftCard->pin != null) {
$giftCardData->appendChild($xml->createElement('hps:PIN', $giftCard->pin));
}
return $giftCardData;
}
|
@param \HpsGiftCard $giftCard
@param \DOMDocument $xml
@param string $elementName
@return \DOMElement
|
entailment
|
public function _hydrateManualEntry(HpsCreditCard $card, DOMDocument $xml, $cardPresent = false, $readerPresent = false)
{
$manualEntry = $xml->createElement('hps:ManualEntry');
if (isset($card->number)) {
$manualEntry->appendChild($xml->createElement('hps:CardNbr', $card->number));
}
if (isset($card->expMonth)) {
$manualEntry->appendChild($xml->createElement('hps:ExpMonth', $card->expMonth));
}
if (isset($card->expYear)) {
$manualEntry->appendChild($xml->createElement('hps:ExpYear', $card->expYear));
}
if (isset($card->cvv)) {
$manualEntry->appendChild($xml->createElement('hps:CVV2', $card->cvv));
}
$manualEntry->appendChild($xml->createElement('hps:CardPresent', ($cardPresent ? 'Y' : 'N')));
$manualEntry->appendChild($xml->createElement('hps:ReaderPresent', ($readerPresent ? 'Y' : 'N')));
return $manualEntry;
}
|
@param \HpsCreditCard $card
@param \DOMDocument $xml
@param bool $cardPresent
@param bool $readerPresent
@return \DOMElement
|
entailment
|
public function _hydrateSecureEcommerce($data, $xml)
{
$secureEcommerce = $xml->createElement('hps:SecureECommerce');
$secureEcommerce->appendChild($xml->createElement('hps:PaymentDataSource', $data->dataSource));
$secureEcommerce->appendChild($xml->createElement('hps:TypeOfPaymentData', $data->type));
$paymentDataElement = $xml->createElement('hps:PaymentData', $data->data);
$paymentDataElementEncoding = $xml->createAttribute('encoding');
$paymentDataElementEncoding->value = 'base64';
$paymentDataElement->appendChild($paymentDataElementEncoding);
$secureEcommerce->appendChild($paymentDataElement);
if ($data->eciFlag != null && $data->eciFlag != '') {
$secureEcommerce->appendChild($xml->createElement('hps:ECommerceIndicator', $data->eciFlag));
}
$xidElement = $xml->createElement('hps:XID', $data->xid);
$xidElementEncoding = $xml->createAttribute('encoding');
$xidElementEncoding->value = 'base64';
$xidElement->appendChild($xidElementEncoding);
$secureEcommerce->appendChild($xidElement);
return $secureEcommerce;
}
|
@param $data
@param $xml
@return mixed
|
entailment
|
public function _hydrateTokenData($token, DOMDocument $xml, $cardPresent = false, $readerPresent = false)
{
if (!$token instanceof HpsTokenData) {
$tokenValue = $token;
$token = new HpsTokenData();
$token->tokenValue = $tokenValue;
}
$tokenData = $xml->createElement('hps:TokenData');
$tokenData->appendChild($xml->createElement('hps:TokenValue', $token->tokenValue));
if (isset($token->expMonth)) {
$tokenData->appendChild($xml->createElement('hps:ExpMonth', $token->expMonth));
}
if (isset($token->expYear)) {
$tokenData->appendChild($xml->createElement('hps:ExpYear', $token->expYear));
}
if (isset($token->cvv)) {
$tokenData->appendChild($xml->createElement('hps:CVV2', $token->cvv));
}
$tokenData->appendChild($xml->createElement('hps:CardPresent', ($cardPresent ? 'Y' : 'N')));
$tokenData->appendChild($xml->createElement('hps:ReaderPresent', ($readerPresent ? 'Y' : 'N')));
return $tokenData;
}
|
@param $token
@param \DOMDocument $xml
@param bool $cardPresent
@param bool $readerPresent
@return \DOMElement
|
entailment
|
public function _hydrateTrackData(HpsTrackData $trackData, $xml)
{
$trackDataElement = $xml->createElement('hps:TrackData', $trackData->value);
$trackDataElementMethod = $xml->createAttribute('method');
$trackDataElementMethod->value = $trackData->method;
$trackDataElement->appendChild($trackDataElementMethod);
return $trackDataElement;
}
|
@param \HpsTrackData $trackData
@param $xml
@return mixed
|
entailment
|
private function _XML2Array($xml)
{
$envelope = simplexml_load_string($xml, "SimpleXMLElement", 0, 'http://schemas.xmlsoap.org/soap/envelope/');
foreach ($envelope->Body as $response) {
foreach ($response->children('http://Hps.Exchange.PosGateway') as $item) {
return $item;
}
}
return null;
}
|
@param $xml
@return mixed
|
entailment
|
private function _XMLFault2String($xml)
{
$dom = new DOMDocument();
$dom->loadXML($xml);
return $dom->getElementsByTagName('faultstring')->item(0)->nodeValue;
}
|
@param $xml
@return string
|
entailment
|
public function execute()
{
parent::execute();
$xml = new DOMDocument();
$hpsTransaction = $xml->createElement('hps:Transaction');
$hpsManageTokens = $xml->createElement('hps:ManageTokens');
$hpsManageTokens->appendChild($xml->createElement('hps:TokenValue', trim((string)$this->token)));
$hpsTokenActions = $xml->createElement('hps:TokenActions');
$hpsSet = $xml->createElement('hps:Set');
$hpsAttribute = $xml->createElement('hps:Attribute');
$hpsAttribute->appendChild($xml->createElement('hps:Name', 'ExpMonth'));
$hpsAttribute->appendChild($xml->createElement('hps:Value', (string)sprintf("%'.02d", (int)$this->expMonth)));
$hpsSet->appendChild($hpsAttribute);
$hpsAttribute = $xml->createElement('hps:Attribute');
$hpsAttribute->appendChild($xml->createElement('hps:Name', 'ExpYear'));
$hpsAttribute->appendChild($xml->createElement('hps:Value', (string)$this->expYear));
$hpsSet->appendChild($hpsAttribute);
$hpsTokenActions->appendChild($hpsSet);
$hpsManageTokens->appendChild($hpsTokenActions);
$hpsTransaction->appendChild($hpsManageTokens);
$trans = $this->service->_submitTransaction($hpsTransaction, 'ManageTokens', null);
$trans->responseCode = '00';
$trans->responseText = '';
return $trans;
}
|
Creates an edit transaction through the HpsCreditService
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsAltPaymentSale')
{
$charge = $rsp->Transaction->$txnType;
$sale = parent::fromDict($rsp, $txnType, $returnType);
$sale->status = isset($charge->Status) ? (string)$charge->Status : null;
$sale->statusMessage = isset($charge->StatusMessage) ? (string)$charge->StatusMessage : null;
return $sale;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public function authorize($sessionId, $amount, $currency, HpsBuyerData $buyer = null, HpsPaymentData $payment = null, HpsShippingInfo $shippingAddress = null, $lineItems = null)
{
HpsInputValidation::checkAmount($amount);
HpsInputValidation::checkCurrency($currency);
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$auth = $xml->createElement('hps:AltPaymentAuth');
$auth->appendChild($xml->createElement('hps:TransactionType', $this->_transactionType));
$auth->appendChild($xml->createElement('hps:SessionId', $sessionId));
$auth->appendChild($this->hydrateBuyerData($buyer, $xml));
$auth->appendChild($xml->createElement('hps:Amt', $amount));
$auth->appendChild($this->hydratePaymentData($payment, $xml));
if ($shippingAddress != null) {
$auth->appendChild($this->hydrateShippingData($shippingAddress, $xml));
}
if ($lineItems != null) {
$auth->appendChild($this->hydrateLineItems($lineItems, $xml));
}
$transaction->appendChild($auth);
return $this->_submitTransaction($transaction, 'AltPaymentAuth');
}
|
@param $sessionId
@param $amount
@param $currency
@param \HpsBuyerData|null $buyer
@param \HpsPaymentData|null $payment
@param \HpsShippingInfo|null $shippingAddress
@param null $lineItems
@return null
@throws \HpsException
@throws \HpsInvalidRequestException
|
entailment
|
public function capture($transactionId, $amount)
{
HpsInputValidation::checkAmount($amount);
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$capture = $xml->createElement('hps:AltPaymentCapture');
$capture->appendChild($xml->createElement('hps:TransactionType', $this->_transactionType));
$capture->appendChild($xml->createElement('hps:GatewayTxnId', $transactionId));
$capture->appendChild($xml->createElement('hps:Amt', $amount));
$payment = $xml->createElement('hps:Payment');
$nvp = $xml->createElement('hps:NameValuePair');
$nvp->appendChild($xml->createElement('hps:Name', 'FullyCapturedFlag'));
$nvp->appendChild($xml->createElement('hps:Value', 'true'));
$payment->appendChild($nvp);
$capture->appendChild($payment);
$transaction->appendChild($capture);
return $this->_submitTransaction($transaction, 'AltPaymentCapture');
}
|
@param $transactionId
@param $amount
@return null
@throws \HpsException
@throws \HpsInvalidRequestException
|
entailment
|
public function refund($transactionId, $isPartial = false, $partialAmount = null)
{
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$return = $xml->createElement('hps:AltPaymentReturn');
$return->appendChild($xml->createElement('hps:TransactionType', $this->_transactionType));
$return->appendChild($xml->createElement('hps:GatewayTxnId', $transactionId));
if ($isPartial) {
$return->appendChild($xml->createElement('hps:Amt', $partialAmount));
}
$payment = $xml->createElement('hps:Return');
$nvp = $xml->createElement('hps:NameValuePair');
$nvp->appendChild($xml->createElement('hps:Name', 'ReturnType'));
$nvp->appendChild($xml->createElement('hps:Value', $isPartial ? 'partial' : 'full'));
$payment->appendChild($nvp);
$return->appendChild($payment);
$transaction->appendChild($return);
return $this->_submitTransaction($transaction, 'AltPaymentReturn');
}
|
@param $transactionId
@param bool $isPartial
@param null $partialAmount
@return null
@throws \HpsException
|
entailment
|
public function void($transactionId)
{
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$void = $xml->createElement('hps:AltPaymentVoid');
$void->appendChild($xml->createElement('hps:TransactionType', $this->_transactionType));
$void->appendChild($xml->createElement('hps:GatewayTxnId', $transactionId));
$transaction->appendChild($void);
return $this->_submitTransaction($transaction, 'AltPaymentVoid');
}
|
@param $transactionId
@return null
@throws \HpsException
|
entailment
|
public function sessionInfo($sessionId)
{
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$info = $xml->createElement('hps:AltPaymentSessionInfo');
$info->appendChild($xml->createElement('hps:TransactionType', $this->_transactionType));
$info->appendChild($xml->createElement('hps:SessionId', $sessionId));
$transaction->appendChild($info);
return $this->_submitTransaction($transaction, 'AltPaymentSessionInfo');
}
|
@param $sessionId
@return null
@throws \HpsException
|
entailment
|
public function status($transactionId)
{
$xml = new DOMDocument();
$transaction = $xml->createElement('hps:Transaction');
$status = $xml->createElement('hps:GetTransactionStatus');
$status->appendChild($xml->createElement('hps:GatewayTxnId', $transactionId));
$transaction->appendChild($status);
return $this->_submitTransaction($transaction, 'GetTransactionStatus');
}
|
@param $transactionId
@return null
@throws \HpsException
|
entailment
|
protected function hydrateBuyerData(HpsBuyerData $buyer, DOMDocument $xml)
{
$data = $xml->createElement('hps:Buyer');
if (isset($buyer->returnUrl)) {
$data->appendChild($this->hydrateNameValuePair('ReturnUrl', $buyer->returnUrl, $xml));
}
if (isset($buyer->cancelUrl)) {
$data->appendChild($this->hydrateNameValuePair('CancelUrl', $buyer->cancelUrl, $xml));
}
if (isset($buyer->emailAddress)) {
$data->appendChild($this->hydrateNameValuePair('EmailAddress', $buyer->emailAddress, $xml));
}
if (isset($buyer->payerId)) {
$data->appendChild($this->hydrateNameValuePair('BuyerId', $buyer->payerId, $xml));
}
if (isset($buyer->credit) && $buyer->credit != false) {
$data->appendChild($this->hydrateNameValuePair('FundingSource', 'credit', $xml));
}
return $data;
}
|
@param \HpsBuyerData $buyer
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
protected function hydrateLineItems($items, DOMDocument $xml)
{
$lineItems = $xml->createElement('hps:LineItem');
foreach ($items as $item) {
if (!$item instanceof HpsLineItem) {
continue;
}
$detail = $xml->createElement('hps:Detail');
if (isset($item->name)) {
$detail->appendChild($this->hydrateNameValuePair('Name', $item->name, $xml));
}
if (isset($item->description)) {
$detail->appendChild($this->hydrateNameValuePair('Description', $item->description, $xml));
}
if (isset($item->number)) {
$detail->appendChild($this->hydrateNameValuePair('Number', $item->number, $xml));
}
if (isset($item->amount)) {
$detail->appendChild($this->hydrateNameValuePair('Amount', $item->amount, $xml));
}
if (isset($item->quantity)) {
$detail->appendChild($this->hydrateNameValuePair('Quantity', $item->quantity, $xml));
}
if (isset($item->taxAmount)) {
$detail->appendChild($this->hydrateNameValuePair('TaxAmount', $item->taxAmount, $xml));
}
$lineItems->appendChild($detail);
}
return $lineItems;
}
|
@param $items
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
protected function hydrateNameValuePair($name, $value, DOMDocument $xml)
{
$nvp = $xml->createElement('hps:NameValuePair');
$nvp->appendChild($xml->createElement('hps:Name', $name));
$nvp->appendChild($xml->createElement('hps:Value', HpsInputValidation::cleanAscii($value)));
return $nvp;
}
|
@param $name
@param $value
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
protected function hydratePaymentData(HpsPaymentData $payment, DOMDocument $xml)
{
$data = $xml->createElement('hps:Payment');
$data->appendChild($this->hydrateNameValuePair('ItemAmount', $payment->subtotal, $xml));
if (isset($payment->shippingAmount)) {
$data->appendChild($this->hydrateNameValuePair('ShippingAmount', $payment->shippingAmount, $xml));
}
if (isset($payment->taxAmount)) {
$data->appendChild($this->hydrateNameValuePair('TaxAmount', $payment->taxAmount, $xml));
}
if (isset($payment->paymentType)) {
$data->appendChild($this->hydrateNameValuePair('PaymentType', $payment->paymentType, $xml));
}
if (isset($payment->invoiceNumber)) {
$data->appendChild($this->hydrateNameValuePair('InvoiceNbr', $payment->invoiceNumber, $xml));
}
return $data;
}
|
@param \HpsPaymentData $payment
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
protected function hydrateShippingData(HpsShippingInfo $info, DOMDocument $xml)
{
$shipping = $xml->createElement('hps:Shipping');
$address = $xml->createElement('hps:Address');
$address->appendChild($this->hydrateNameValuePair('AllowAddressOverride', 'false', $xml));
$address->appendChild($this->hydrateNameValuePair('ShipName', $info->name, $xml));
$address->appendChild($this->hydrateNameValuePair('ShipAddress', $info->address->address, $xml));
$address->appendChild($this->hydrateNameValuePair('ShipCity', $info->address->city, $xml));
$address->appendChild($this->hydrateNameValuePair('ShipState', $info->address->state, $xml));
$address->appendChild($this->hydrateNameValuePair('ShipZip', $info->address->zip, $xml));
$address->appendChild($this->hydrateNameValuePair('ShipCountryCode', $info->address->country, $xml));
$shipping->appendChild($address);
return $shipping;
}
|
@param \HpsShippingInfo $info
@param \DOMDocument $xml
@return \DOMElement
|
entailment
|
private function _processGatewayResponse($response, $expectedType)
{
$gatewayRspCode = (isset($response->Header->GatewayRspCode) ? $response->Header->GatewayRspCode : null);
$transactionId = (isset($response->Header->GatewayTxnId) ? $response->Header->GatewayTxnId : null);
if ($gatewayRspCode == '0') {
return;
}
if ($gatewayRspCode == '30') {
try {
$this->void($transactionId);
} catch (Exception $e) {
throw new HpsGatewayException(
HpsExceptionCodes::GATEWAY_TIMEOUT_REVERSAL_ERROR,
'Error occurred while reversing a charge due to HPS gateway timeout',
$e,
null,
null,
$transactionId
);
}
}
HpsGatewayResponseValidation::checkResponse($response, $expectedType);
}
|
@param $response
@param $expectedType
@throws \HpsAuthenticationException
@throws \HpsGatewayException
@throws null
|
entailment
|
private function _processProcessorResponse($response, $expectedType)
{
$transactionId = (isset($response->Header->GatewayTxnId) ? $response->Header->GatewayTxnId : null);
$item = $response->Transaction->$expectedType;
if ($item != null) {
$responseCode = (isset($item->RspCode) ? $item->RspCode : null);
$responseMessage = (isset($item->RspMessage) ? $item->RspMessage : null);
if ($responseCode == null && isset($item->TransactionStatus->RspCode)) {
$responseCode = $item->TransactionStatus->RspCode;
}
if ($responseMessage == null && isset($item->TransactionStatus->RspText)) {
$responseMessage = $item->TransactionStatus->RspText;
}
HpsProcessorResponseValidation::checkResponse($transactionId, $responseCode, $responseMessage, $item);
}
}
|
@param $response
@param $expectedType
@throws \HpsProcessorException
@throws null
|
entailment
|
private function _submitTransaction($transaction, $txnType, $clientTxnId = null, $cardData = null)
{
try {
$response = $this->doRequest($transaction, $clientTxnId);
} catch (HpsException $e) {
if ($e->innerException != null && $e->innerException->getMessage() == 'gateway_time-out') {
// if (in_array($txnType, array('CreditSale', 'CreditAuth'))) {
// try {
// $this->reverse($cardData, $this->_amount, $this->_currency);
// } catch (Exception $e) {
// throw new HpsGatewayException('0', HpsExceptionCodes::GATEWAY_TIMEOUT_REVERSAL_ERROR);
// }
// }
throw new HpsException('An error occurred and the gateway has timed out', 'gateway_timeout', $e, 'gateway_timeout');
}
throw $e;
}
$this->_processGatewayResponse($response, $txnType);
$this->_processProcessorResponse($response, $txnType);
$rvalue = null;
switch ($txnType) {
case 'AltPaymentCreateSession':
$rvalue = HpsAltPaymentCreateSession::fromDict($response, $txnType);
break;
case 'AltPaymentSessionInfo':
$rvalue = HpsAltPaymentSessionInfo::fromDict($response, $txnType);
break;
case 'AltPaymentSale':
$rvalue = HpsAltPaymentSale::fromDict($response, $txnType);
break;
case 'AltPaymentAuth':
$rvalue = HpsAltPaymentAuth::fromDict($response, $txnType);
break;
case 'AltPaymentCapture':
$rvalue = HpsAltPaymentCapture::fromDict($response, $txnType);
break;
case 'AltPaymentReturn':
$rvalue = HpsAltPaymentReturn::fromDict($response, $txnType);
break;
case 'AltPaymentVoid':
$rvalue = HpsAltPaymentVoid::fromDict($response, $txnType);
break;
case 'GetTransactionStatus':
$rvalue = HpsTransactionStatus::fromDict($response, $txnType);
break;
default:
break;
}
return $rvalue;
}
|
@param $transaction
@param $txnType
@param null $clientTxnId
@param null $cardData
@return null
@throws \HpsException
@throws \HpsGatewayException
|
entailment
|
public static function checkResponse($response, $expectedType)
{
$rspCode = $response->Header->GatewayRspCode;
$rspText = $response->Header->GatewayRspMsg;
$transactionId = (isset($response->Header->GatewayTxnId) ? $response->Header->GatewayTxnId : null);
$e = HpsGatewayResponseValidation::getException($rspCode, $rspText, $response);
if ($e != null) {
if ($e instanceof HpsGatewayException) {
$e->transactionId = $transactionId;
}
throw $e;
}
if (!isset($response->Transaction) || !isset($response->Transaction->$expectedType)) {
throw new HpsGatewayException(
HpsExceptionCodes::UNEXPECTED_GATEWAY_ERROR,
'Unexpected response from HPS gateway',
null,
null,
null,
$transactionId
);
}
}
|
@param $response
@param $expectedType
@throws \HpsAuthenticationException
@throws \HpsGatewayException
@throws null
|
entailment
|
public static function getException($responseCode, $responseText, $response)
{
$e = null;
switch ($responseCode) {
case '0':
break;
case '-2':
$e = new HpsAuthenticationException(
HpsExceptionCodes::AUTHENTICATION_ERROR,
'Authentication Error. Please double check your service configuration'
);
break;
case '3':
$e = new HpsGatewayException(
HpsExceptionCodes::INVALID_ORIGINAL_TRANSACTION,
$responseText,
$responseCode,
$responseText
);
break;
case '5':
$e = new HpsGatewayException(
HpsExceptionCodes::NO_OPEN_BATCH,
$responseText,
$responseCode,
$responseText
);
break;
case '12':
$e = new HpsGatewayException(
HpsExceptionCodes::INVALID_CPC_DATA,
'Invalid CPC data',
$responseCode,
$responseText
);
break;
case '27':
case '34':
case '26':
case '13':
$e = new HpsGatewayException(
HpsExceptionCodes::INVALID_CARD_DATA,
'Invalid card data',
$responseCode,
$responseText
);
break;
case '14':
$e = new HpsGatewayException(
HpsExceptionCodes::INVALID_NUMBER,
'The card number is not valid',
$responseCode,
$responseText
);
break;
case '30':
$e = new HpsGatewayException(
HpsExceptionCodes::GATEWAY_ERROR,
'Gateway timed out',
$responseCode,
$responseText
);
break;
case '1':
default:
$e = new HpsGatewayException(
HpsExceptionCodes::UNKNOWN_GATEWAY_ERROR,
$responseText,
$responseCode,
$responseText
);
}
return $e;
}
|
@param $responseCode
@param $responseText
@param $response
@return \HpsAuthenticationException|\HpsGatewayException|null
|
entailment
|
public static function getEditableFields( HpsPayPlanSchedule $schedule = null )
{
$editableFields = array(
'scheduleName',
'scheduleStatus',
'deviceId',
'paymentMethodKey',
'subtotalAmount',
'taxAmount',
'numberOfPaymentsRemaining',
'endDate',
'reprocessingCount',
'emailReceipt',
'emailAdvanceNotice',
'processingDateInfo',
'invoiceNbr',
'description',
);
if ($schedule->scheduleStarted === true){
$editableFields[] = 'cancellationDate';
$editableFields[] = 'nextProcessingDate';
}
// Only editable when scheduleStarted = false
else{
$editableFields[] = 'scheduleIdentifier';
$editableFields[] = 'startDate';
$editableFields[] = 'frequency';
$editableFields[] = 'duration';
}
return $editableFields;
}
|
@param \HpsPayPlanSchedule|null $schedule
@return array
|
entailment
|
public static function fromStdClass($obj)
{
$ret = new HpsPayPlanSchedule();
$ret->scheduleKey = property_exists($obj, 'scheduleKey') ? $obj->scheduleKey : null;
$ret->scheduleIdentifier = property_exists($obj, 'scheduleIdentifier') ? $obj->scheduleIdentifier : null;
$ret->customerKey = property_exists($obj, 'customerKey') ? $obj->customerKey : null;
$ret->scheduleName = property_exists($obj, 'scheduleName') ? $obj->scheduleName : null;
$ret->scheduleStatus = property_exists($obj, 'scheduleStatus') ? $obj->scheduleStatus : null;
$ret->paymentMethodKey = property_exists($obj, 'paymentMethodKey') ? $obj->paymentMethodKey : null;
$ret->subtotalAmount = property_exists($obj, 'subtotalAmount') ? $obj->subtotalAmount : null;
$ret->taxAmount = property_exists($obj, 'taxAmount') ? $obj->taxAmount : null;
$ret->totalAmount = property_exists($obj, 'totalAmount') ? $obj->totalAmount : null;
$ret->deviceId = property_exists($obj, 'deviceId') ? $obj->deviceId : null;
$ret->startDate = property_exists($obj, 'startDate') ? $obj->startDate : null;
$ret->processingDateInfo = property_exists($obj, 'processingDateInfo') ? $obj->processingDateInfo : null;
$ret->frequency = property_exists($obj, 'frequency') ? $obj->frequency : null;
$ret->duration = property_exists($obj, 'duration') ? $obj->duration : null;
$ret->endDate = property_exists($obj, 'endDate') ? $obj->endDate : null;
$ret->reprocessingCount = property_exists($obj, 'reprocessingCount') ? $obj->reprocessingCount : null;
$ret->emailReceipt = property_exists($obj, 'emailReceipt') ? $obj->emailReceipt : null;
$ret->emailAdvanceNotice = property_exists($obj, 'emailAdvanceNotice') ? $obj->emailAdvanceNotice : null;
$ret->nextProcessingDate = property_exists($obj, 'nextProcessingDate') ? $obj->nextProcessingDate : null;
$ret->previousProcessingDate = property_exists($obj, 'previousProcessingDate') ? $obj->previousProcessingDate : null;
$ret->approvedTransactionCount = property_exists($obj, 'approvedTransactionCount') ? $obj->approvedTransactionCount : null;
$ret->failureCount = property_exists($obj, 'failureCount') ? $obj->failureCount : null;
$ret->totalApprovedAmountToDate = property_exists($obj, 'totalApprovedAmountToDate') ? $obj->totalApprovedAmountToDate : null;
$ret->numberOfPaymentsRemaining = property_exists($obj, 'numberOfPaymentsRemaining') ? $obj->numberOfPaymentsRemaining : null;
$ret->cancellationDate = property_exists($obj, 'cancellationDate') ? $obj->cancellationDate : null;
$ret->scheduleStarted = property_exists($obj, 'scheduleStarted') ? $obj->scheduleStarted : null;
$ret->creationDate = property_exists($obj, 'creationDate') ? $obj->creationDate : null;
$ret->lastChangeDate = property_exists($obj, 'lastChangeDate') ? $obj->lastChangeDate : null;
$ret->statusSetDate = property_exists($obj, 'statusSetDate') ? $obj->statusSetDate : null;
$ret->description = property_exists($obj, 'description') ? $obj->description : null;
$ret->invoiceNbr = property_exists($obj, 'invoiceNbr') ? $obj->invoiceNbr : null;
return $ret;
}
|
@param $obj
@return \HpsPayPlanSchedule
|
entailment
|
public function getEditableFieldsWithValues($params = null,$class = 'HpsPayPlanSchedule'){
if ($params===null){
$params=$this;
}
return parent::getEditableFieldsWithValues($class, $params);
}
|
@param null $params
@param string $class
@return array
|
entailment
|
public function execute()
{
parent::execute();
$addValueSvc = new HpsGiftCardService($this->service->servicesConfig());
if ($this->token != null && ($this->token instanceof HpsTokenData)) {
if ($this->card == null) {
$this->card = new HpsGiftCard();
}
$this->card->tokenValue = $this->token->tokenValue;
}
return $addValueSvc->addValue(
$this->amount,
$this->currency,
$this->card
);
}
|
Creates an addValue transaction through the HpsGiftCardService
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsOfflineAuthorization')
{
$offlineAuth = parent::fromDict($rsp, $txnType, $returnType);
$offlineAuth->responseCode = '00';
$offlineAuth->responseText = '';
return $offlineAuth;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public function activate($amount = null)
{
$builder = new HpsGiftCardServiceActivateBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsGiftCardServiceActivateBuilder
|
entailment
|
public function reverse($amount = null)
{
$builder = new HpsGiftCardServiceReverseBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsGiftCardServiceReverseBuilder
|
entailment
|
public function reward($amount = null)
{
$builder = new HpsGiftCardServiceRewardBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsGiftCardServiceRewardBuilder
|
entailment
|
public function sale($amount = null)
{
$builder = new HpsGiftCardServiceSaleBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsGiftCardServiceSaleBuilder
|
entailment
|
public function _submitTransaction($transaction, $txnType, $clientTxnId = null)
{
$response = $this->doRequest($transaction, $clientTxnId);
HpsGatewayResponseValidation::checkResponse($response, $txnType);
HpsIssuerResponseValidation::checkResponse(
$response->Header->GatewayTxnId,
$response->Transaction->$txnType->RspCode,
$response->Transaction->$txnType->RspText,
'gift'
);
$rvalue = '';
switch ($txnType) {
case 'GiftCardActivate':
$rvalue = HpsGiftCardActivate::fromDict($response, $txnType, 'HpsGiftCardActivate');
break;
case 'GiftCardAddValue':
$rvalue = HpsGiftCardAddValue::fromDict($response, $txnType, 'HpsGiftCardAddValue');
break;
case 'GiftCardAlias':
$rvalue = HpsGiftCardAlias::fromDict($response, $txnType, 'HpsGiftCardAlias');
break;
case 'GiftCardBalance':
$rvalue = HpsGiftCardBalance::fromDict($response, $txnType, 'HpsGiftCardBalance');
break;
case 'GiftCardDeactivate':
$rvalue = HpsGiftCardDeactivate::fromDict($response, $txnType, 'HpsGiftCardDeactivate');
break;
case 'GiftCardReplace':
$rvalue = HpsGiftCardReplace::fromDict($response, $txnType, 'HpsGiftCardReplace');
break;
case 'GiftCardReward':
$rvalue = HpsGiftCardReward::fromDict($response, $txnType, 'HpsGiftCardReward');
break;
case 'GiftCardSale':
$rvalue = HpsGiftCardSale::fromDict($response, $txnType, 'HpsGiftCardSale');
break;
case 'GiftCardVoid':
$rvalue = HpsGiftCardVoid::fromDict($response, $txnType, 'HpsGiftCardVoid');
break;
case 'GiftCardReversal':
$rvalue = HpsGiftCardReversal::fromDict($response, $txnType, 'HpsGiftCardReversal');
break;
default:
break;
}
return $rvalue;
}
|
@param $transaction
@param $txnType
@param null $clientTxnId
@return \HpsGiftCardAlias|string
@throws \HpsAuthenticationException
@throws \HpsCreditException
@throws \HpsGatewayException
@throws null
|
entailment
|
public function authorize($amount = null)
{
$builder = new HpsCreditServiceAuthorizeBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceAuthorizeBuilder
|
entailment
|
public function charge($amount = null)
{
$builder = new HpsCreditServiceChargeBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceChargeBuilder
|
entailment
|
public function offlineAuth($amount = null)
{
$builder = new HpsCreditServiceOfflineAuthBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceOfflineAuthBuilder
|
entailment
|
public function offlineCharge($amount = null)
{
$builder = new HpsCreditServiceOfflineChargeBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceOfflineChargeBuilder
|
entailment
|
public function prepaidAddValue($amount = null)
{
$builder = new HpsCreditServicePrepaidAddValueBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServicePrepaidAddValueBuilder
|
entailment
|
public function refund($amount = null)
{
$builder = new HpsCreditServiceRefundBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceRefundBuilder
|
entailment
|
public function reverse($amount = null)
{
$builder = new HpsCreditServiceReverseBuilder($this);
return $builder
->withAmount($amount)
->withCurrency('usd');
}
|
@param null $amount
@return \HpsCreditServiceReverseBuilder
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsCPCEdit')
{
$cpcEdit = parent::fromDict($rsp, $txnType, $returnType);
$cpcEdit->responseCode = '00';
$cpcEdit->responseText = '';
return $cpcEdit;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public static function fromObject($data, $returnType = 'HpsCardinalMPIPreapprovalResponse')
{
$response = parent::fromObject($data, $returnType);
$response->longAccessToken = self::readDataKey($data, 'LongAccessToken');
$response->preCheckoutData = isset($data->PrecheckoutData) ? simplexml_load_string($data->PrecheckoutData)->PrecheckoutData : null;
$response->preCheckoutTransactionId = self::readDataKey($data, 'PrecheckoutTransactionId');
return $response;
}
|
@param $data
@param string $returnType
@return mixed
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsVoid')
{
$void = parent::fromDict($rsp, $txnType, $returnType);
$void->responseCode = '00';
$void->responseText = '';
return $void;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public static function getEditableFields($type = null)
{
$fields = array(
'preferredPayment',
'paymentStatus',
'paymentMethodIdentifier',
'nameOnAccount',
'addressLine1',
'addressLine2',
'city',
'stateProvince',
'zipPostalCode',
);
$ccOnly = array(
'expirationDate',
'country',
);
$achOnly = array(
'telephoneIndicator',
'accountHolderYob',
'driversLicenseState',
'driversLicenseNumber',
'socialSecurityNumberLast4',
);
switch ($type) {
case HpsPayPlanPaymentMethodType::ACH:
return array_merge($fields, $achOnly);
break;
case HpsPayPlanPaymentMethodType::CREDIT_CARD:
return array_merge($fields, $ccOnly);
break;
default:
return array_merge($fields, $achOnly, $ccOnly);
break;
}
}
|
@param null $type
@return array
|
entailment
|
public static function fromStdClass($obj)
{
$ret = new HpsPayPlanPaymentMethod();
$ret->paymentMethodKey = property_exists($obj, 'paymentMethodKey') ? $obj->paymentMethodKey : null;
$ret->paymentMethodType = property_exists($obj, 'paymentMethodType') ? $obj->paymentMethodType : null;
$ret->preferredPayment = property_exists($obj, 'preferredPayment') ? $obj->preferredPayment : null;
$ret->paymentStatus = property_exists($obj, 'paymentStatus') ? $obj->paymentStatus : null;
$ret->paymentMethodIdentifier = property_exists($obj, 'paymentMethodIdentifier') ? $obj->paymentMethodIdentifier : null;
$ret->customerKey = property_exists($obj, 'customerKey') ? $obj->customerKey : null;
$ret->customerIdentifier = property_exists($obj, 'customerIdentifier') ? $obj->customerIdentifier : null;
$ret->customerStatus = property_exists($obj, 'customerStatus') ? $obj->customerStatus : null;
$ret->firstName = property_exists($obj, 'firstName') ? $obj->firstName : null;
$ret->lastName = property_exists($obj, 'lastName') ? $obj->lastName : null;
$ret->company = property_exists($obj, 'company') ? $obj->company : null;
$ret->nameOnAccount = property_exists($obj, 'nameOnAccount') ? $obj->nameOnAccount : null;
$ret->accountNumberLast4 = property_exists($obj, 'accountNumberLast4') ? $obj->accountNumberLast4 : null;
$ret->paymentMethod = property_exists($obj, 'paymentMethod') ? $obj->paymentMethod : null;
$ret->cardBrand = property_exists($obj, 'cardBrand') ? $obj->cardBrand : null;
$ret->expirationDate = property_exists($obj, 'expirationDate') ? $obj->expirationDate : null;
$ret->cvvResponseCode = property_exists($obj, 'cvvResponseCode') ? $obj->cvvResponseCode : null;
$ret->avsResponseCode = property_exists($obj, 'avsResponseCode') ? $obj->avsResponseCode : null;
$ret->achType = property_exists($obj, 'achType') ? $obj->achType : null;
$ret->accountType = property_exists($obj, 'accountType') ? $obj->accountType : null;
$ret->routingNumber = property_exists($obj, 'routingNumber') ? $obj->routingNumber : null;
$ret->telephoneIndicator = property_exists($obj, 'telephoneIndicator') ? $obj->telephoneIndicator : null;
$ret->addressLine1 = property_exists($obj, 'addressLine1') ? $obj->addressLine1 : null;
$ret->addressLine2 = property_exists($obj, 'addressLine2') ? $obj->addressLine2 : null;
$ret->city = property_exists($obj, 'city') ? $obj->city : null;
$ret->stateProvince = property_exists($obj, 'stateProvince') ? $obj->stateProvince : null;
$ret->zipPostalCode = property_exists($obj, 'zipPostalCode') ? $obj->zipPostalCode : null;
$ret->country = property_exists($obj, 'country') ? $obj->country : null;
$ret->accountHolderYob = property_exists($obj, 'accountHolderYob') ? $obj->accountHolderYob : null;
$ret->driversLicenseState = property_exists($obj, 'driversLicenseState') ? $obj->driversLicenseState : null;
$ret->driversLicenseNumber = property_exists($obj, 'driversLicenseNumber') ? $obj->driversLicenseNumber : null;
$ret->socialSecurityNumberLast4 = property_exists($obj, 'socialSecurityNumberLast4') ? $obj->socialSecurityNumberLast4 : null;
$ret->hasSchedules = property_exists($obj, 'hasSchedules') ? $obj->hasSchedules : null;
$ret->hasActiveSchedules = property_exists($obj, 'hasActiveSchedules') ? $obj->hasActiveSchedules : null;
$ret->creationDate = property_exists($obj, 'creationDate') ? $obj->creationDate : null;
$ret->lastChangeDate = property_exists($obj, 'lastChangeDate') ? $obj->lastChangeDate : null;
$ret->statusSetDate = property_exists($obj, 'statusSetDate') ? $obj->statusSetDate : null;
return $ret;
}
|
@param $obj
@return \HpsPayPlanPaymentMethod
|
entailment
|
public static function fromDict($rsp, $txnType, $returnType = 'HpsAltPaymentSessionInfo')
{
$sessionInfo = $rsp->Transaction->$txnType;
$buyer = self::nvpToArray($sessionInfo->Buyer);
$payment = self::nvpToArray($sessionInfo->Payment);
$shipping = self::nvpToArray($sessionInfo->Shipping->Address);
$lineItems = self::nvpToArray($sessionInfo->LineItem->Detail);
$session = parent::fromDict($rsp, $txnType, $returnType);
$session->status = isset($sessionInfo->Status) ? (string)$sessionInfo->Status : null;
$session->buyer = new HpsBuyerData();
$session->buyer->emailAddress = isset($buyer['EmailAddress']) ? $buyer['EmailAddress'] : null;
$session->buyer->payerId = isset($buyer['BuyerId']) ? $buyer['BuyerId'] : null;
$session->buyer->status = isset($buyer['Status']) ? $buyer['Status'] : null;
$session->buyer->countryCode = isset($buyer['CountryCode']) ? $buyer['CountryCode'] : null;
$session->buyer->firstName = isset($buyer['FirstName']) ? $buyer['FirstName'] : null;
$session->buyer->lastName = isset($buyer['LastName']) ? $buyer['LastName'] : null;
$session->shipping = new HpsShippingInfo();
$session->shipping->name = isset($shipping['ShipName']) ? $shipping['ShipName'] : null;
$session->shipping->address = new HpsAddress();
$session->shipping->address->address = isset($shipping['ShipAddress']) ? $shipping['ShipAddress'] : null;
$session->shipping->address->city = isset($shipping['ShipCity']) ? $shipping['ShipCity'] : null;
$session->shipping->address->state = isset($shipping['ShipState']) ? $shipping['ShipState'] : null;
$session->shipping->address->zip = isset($shipping['ShipZip']) ? $shipping['ShipZip'] : null;
$session->shipping->address->country = isset($shipping['ShipCountryCode']) ? $shipping['ShipCountryCode'] : null;
$session->payment = new HpsPaymentData();
$session->payment->subtotal = isset($payment['ItemAmount']) ? $payment['ItemAmount'] : null;
$session->payment->shippingAmount = isset($payment['ShippingAmount']) ? $payment['ShippingAmount'] : null;
$session->payment->taxAmount = isset($payment['TaxAmount']) ? $payment['TaxAmount'] : null;
$session->lineItems = array();
$lineItem = new HpsLineitem();
$lineItem->name = isset($lineItems['Name']) ? $lineItems['Name'] : null;
$lineItem->amount = isset($lineItems['Amount']) ? $lineItems['Amount'] : null;
$lineItem->number = isset($lineItems['Number']) ? $lineItems['Number'] : null;
$lineItem->quantity = isset($lineItems['Quantity']) ? $lineItems['Quantity'] : null;
$lineItem->taxAmount = isset($lineItems['TaxAmount']) ? $lineItems['TaxAmount'] : null;
return $session;
}
|
@param $rsp
@param $txnType
@param string $returnType
@return mixed
|
entailment
|
public function execute()
{
parent::execute();
return $this->service->_buildTransaction(
'OVERRIDE',
$this->check,
$this->amount,
$this->clientTransactionId
);
}
|
Creates an override transaction through the HpsCheckService
|
entailment
|
public static function fromObject($data, $returnType = 'HpsCardinalMPIAuthenticateResponse')
{
$response = parent::fromObject($data, $returnType);
$response->authenticateMethod = self::readDataKey($data, 'AuthenticateMethod');
$response->authorizationCode = self::readDataKey($data, 'AuthorizationCode');
$response->cardBin = self::readDataKey($data, 'CardBin');
$response->cardEnrollmentMethod = self::readDataKey($data, 'CardEnrollmentMethod');
$response->cardExpMonth = self::readDataKey($data, 'CardExpMonth');
$response->cardExpYear = self::readDataKey($data, 'CardExpYear');
$response->cardLastFour = self::readDataKey($data, 'CardLastFour');
$response->cardType = self::readDataKey($data, 'CardType');
$response->cardTypeName = self::readDataKey($data, 'CardTypeName');
$response->longAccessToken = self::readDataKey($data, 'LongAccessToken');
$response->mastercardAssignedId = self::readDataKey($data, 'MasterCardAssignedId');
$response->nameOnCard = self::readDataKey($data, 'NameOnCard');
$response->paResStatus = self::readDataKey($data, 'PaResStatus');
$response->payPassWalletIndicator = self::readDataKey($data, 'PayPassWalletIndicator');
$response->paymentProcessorOrderNumber = self::readDataKey($data, 'PaymentProcessorOrderNumber');
$response->processorBillingAddress1 = self::readDataKey($data, 'ProcessorBillingAddress1');
$response->processorBillingAddress2 = self::readDataKey($data, 'ProcessorBillingAddress2');
$response->processorBillingCity = self::readDataKey($data, 'ProcessorBillingCity');
$response->processorBillingCountryCode = self::readDataKey($data, 'ProcessorBillingCountryCode');
$response->processorBillingFirstName = self::readDataKey($data, 'ProcessorBillingFirstName');
$response->processorBillingLastName = self::readDataKey($data, 'ProcessorBillingLastName');
$response->processorBillingMiddleName = self::readDataKey($data, 'ProcessorBillingMiddleName');
$response->processorBillingPhone = self::readDataKey($data, 'ProcessorBillingPhone');
$response->processorBillingPostalCode = self::readDataKey($data, 'ProcessorBillingPostalCode');
$response->processorBillingState = self::readDataKey($data, 'ProcessorBillingState');
$response->processorCavv = self::readDataKey($data, 'ProcessorCavv');
$response->processorEciFlag = self::readDataKey($data, 'ProcessorEciFlag');
$response->processorEmail = self::readDataKey($data, 'ProcessorEmail');
$response->processorPayresStatus = self::readDataKey($data, 'ProcessorPayresStatus');
$response->processorShippingAddress1 = self::readDataKey($data, 'ProcessorShippingAddress1');
$response->processorShippingAddress2 = self::readDataKey($data, 'ProcessorShippingAddress2');
$response->processorShippingCity = self::readDataKey($data, 'ProcessorShippingCity');
$response->processorShippingCountryCode = self::readDataKey($data, 'ProcessorShippingCountryCode');
$response->processorShippingFullName = self::readDataKey($data, 'ProcessorShippingFullName');
$response->processorShippingPhone = self::readDataKey($data, 'ProcessorShippingPhone');
$response->processorShippingPostalCode = self::readDataKey($data, 'ProcessorShippingPostalCode');
$response->processorShippingState = self::readDataKey($data, 'ProcessorShippingState');
$response->processorSignatureVerification = self::readDataKey($data, 'ProcessorSignatureVerification');
$response->processorXid = self::readDataKey($data, 'ProcessorXid');
$response->rewardExpMonth = self::readDataKey($data, 'RewardExpMonth');
$response->rewardExpYear = self::readDataKey($data, 'RewardExpYear');
$response->rewardId = self::readDataKey($data, 'RewardId');
$response->rewardName = self::readDataKey($data, 'RewardName');
$response->rewardNumber = self::readDataKey($data, 'RewardNumber');
$response->scEnrollmentStatus = self::readDataKey($data, 'ScEnrollmentStatus');
$response->signatureVerification = self::readDataKey($data, 'SignatureVerification');
return $response;
}
|
@param $data
@param string $returnType
@return mixed
|
entailment
|
public function add(HpsPayPlanCustomer $customer)
{
$data = $customer->getEditableFieldsWithValues();
$result = $this->doRequest($data, array(
'verb' => 'POST',
'endpoint' => 'customers',
));
return $this->hydrateObject($result, 'HpsPayPlanCustomer');
}
|
@param \HpsPayPlanCustomer $customer
@return mixed
|
entailment
|
public function edit(HpsPayPlanCustomer $customer)
{
$data = $customer->getEditableFieldsWithValues();
$result = $this->doRequest($data, array(
'verb' => 'PUT',
'endpoint' => 'customers/'.$customer->customerKey,
));
return $this->hydrateObject($result, 'HpsPayPlanCustomer');
}
|
@param \HpsPayPlanCustomer $customer
@return mixed
|
entailment
|
public function findAll($searchFields = array())
{
// Cannot have an array as the root object
// in a JSON document
$data = $searchFields === array() ? (object)array() : $searchFields;
$results = $this
->doRequest($data, array(
'verb' => 'POST',
'endpoint' => 'searchCustomers',
));
return $this->hydrateSearchResults($results, 'HpsPayPlanCustomer');
}
|
@param array $searchFields
@return object
|
entailment
|
public function get($customer)
{
$id = null;
if ($customer instanceof HpsPayPlanCustomer) {
$id = $customer->customerKey;
} else {
$id = $customer;
}
$result = $this->doRequest(null, array(
'verb' => 'GET',
'endpoint' => 'customers/'.$id,
));
return $this->hydrateObject($result, 'HpsPayPlanCustomer');
}
|
@param $customer
@return mixed
|
entailment
|
public function delete($customer, $forceDelete = false)
{
$id = null;
if ($customer instanceof HpsPayPlanCustomer) {
$id = $customer->customerKey;
} else {
$id = $customer;
}
$data = array(
'forceDelete' => $forceDelete,
);
return $this->doRequest($data, array(
'verb' => 'DELETE',
'endpoint' => 'customers/'.$id,
));
}
|
@param $customer
@param bool $forceDelete
@return mixed
|
entailment
|
public function addOrderNumber(
$orderId,
HpsOrderData $orderData
) {
$payload = array(
'OrderId' => $orderId,
'OrderNumber' => $orderData->orderNumber,
'TransactionType' => 'WT',
);
return $this->submitTransaction($payload, 'cmpi_add_order_number');
}
|
Updates the Merchant’s front-end order number with their back-end order
number in the Centinel system. The Merchant’s original order number is
persisted and searchable. The transaction expects the OrderId and
OrderNumber values to correspond to the original Lookup response message.
@param string $orderId order id from Cardinal
@param HpsOrderData $orderData Cardinal/MasterPass specific data
@return object
|
entailment
|
public function authenticate(
$orderId,
$oauthToken,
$oauthVerifier,
$payload,
$resourceUrl,
HpsOrderData $orderData = null
) {
$data = array(
'OrderId' => $orderId,
'PAResPayload' => $payload,
'Status' => $orderData->transactionStatus,
'TransactionType' => 'WT',
);
if ($orderData->checkoutType === HpsCentinelCheckoutType::PAIRING
|| $orderData->checkoutType === HpsCentinelCheckoutType::PAIRING_CHECKOUT
) {
$data['PairingToken'] = $orderData->pairingToken;
$data['PairingVerifier'] = $orderData->pairingVerifier;
}
if ($orderData->checkoutType === null
|| $orderData->checkoutType === HpsCentinelCheckoutType::LIGHTBOX
|| $orderData->checkoutType === HpsCentinelCheckoutType::PAIRING_CHECKOUT
) {
$data['CheckoutResourceUrl'] = $resourceUrl;
$data['OAuthToken'] = $oauthToken;
$data['OAuthVerifier'] = $oauthVerifier;
}
return $this->submitTransaction($data, 'cmpi_authenticate');
}
|
Responsible for returning the status of the MasterPass transaction to the
Merchant. The message will return the status of the transaction, enabling
the Merchant to handle the order according to the outcome. In the event
that the ErrorNo element is 0 (zero) then the PAResStatus value will define
how the transaction should be processed. Based on the transaction outcome
the Merchant's order management system should be updated and the appropriate
message should be displayed to the consumer. In the event that a nonzero
ErrorNo value is returned or PAResStatus value is not Y, the consumer should
be prompted for an alternate form of payment.
@param string $orderId order id from Cardinal
@param string $oauthToken oauth token from MasterPass
@param string $oauthVerifier oauth verifier from MasterPass
@param string $payload payload data from Cardinal
@param string $resourceUrl resource URL from MasterPass
@param HpsOrderData $orderData Cardinal/MasterPass specific data
@return object
|
entailment
|
public function authorize(
$orderId,
$amount,
$currency,
HpsBuyerData $buyer = null,
HpsPaymentData $payment = null,
HpsShippingInfo $shippingAddress = null,
$lineItems = null,
HpsOrderData $orderData = null
) {
$payload = array(
'TransactionType' => 'WT',
'Amount' => $this->formatAmount($amount),
'OrderId' => $orderId,
'CurrencyCode' => $this->currencyStringToNumeric($currency),
);
if ($buyer !== null) {
$payload = array_merge($payload, $this->hydrateBuyerData($buyer));
}
if ($payment !== null) {
$payload = array_merge($payload, $this->hydratePaymentData($payment));
}
if ($shippingAddress !== null) {
$payload = array_merge(
$payload,
$this->hydrateShippingInfo($shippingAddress)
);
}
if ($lineItems !== null) {
$payload = array_merge($payload, $this->hydrateLineItems($lineItems));
}
return $this->submitTransaction($payload, 'cmpi_authorize');
}
|
Responsible for authorizing the transaction. Once authorized, the
transaction amount can be captured at a later point in time. Once the
Merchant is ready to perform the actual Authorization of funds the
Authorize message should be processes referencing the original OrderId
returned in the Lookup message. This authorization request checks the
availability of the Customer’s funds to obtain an honor period for
capture/settlement.
@param string $orderId order id from Cardinal
@param mixed $amount amount to be authorized
@param string $currency currency code
@param HpsBuyerData $buyer buyer information
@param HpsPaymentData $payment payment information
@param HpsShippingInfo $shippingAddress shipping information
@param array<int, HpsLineItem> $lineItems line items from order
@param HpsOrderData $orderData Cardinal/MasterPass specific
data
@return object
|
entailment
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.