mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-06 03:02:34 +01:00
333 lines
11 KiB
PHP
333 lines
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2020. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://opensource.org/licenses/AAL
|
|
*/
|
|
|
|
namespace App\PaymentDrivers;
|
|
|
|
use App\Events\Payment\PaymentWasCreated;
|
|
use App\Jobs\Mail\PaymentFailureMailer;
|
|
use App\Jobs\Util\SystemLogger;
|
|
use App\Models\ClientGatewayToken;
|
|
use App\Models\GatewayType;
|
|
use App\Models\Payment;
|
|
use App\Models\PaymentHash;
|
|
use App\Models\PaymentType;
|
|
use App\Models\SystemLog;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\Traits\MakesHash;
|
|
use Exception;
|
|
use Omnipay\Common\Item;
|
|
use stdClass;
|
|
|
|
/**
|
|
* Response array
|
|
* (.
|
|
'TOKEN' => 'EC-50V302605X606694D',
|
|
'SUCCESSPAGEREDIRECTREQUESTED' => 'false',
|
|
'TIMESTAMP' => '2019-09-30T22:21:21Z',
|
|
'CORRELATIONID' => '9e0da63193090',
|
|
'ACK' => 'SuccessWithWarning',
|
|
'VERSION' => '119.0',
|
|
'BUILD' => '53688488',
|
|
'L_ERRORCODE0' => '11607',
|
|
'L_SHORTMESSAGE0' => 'Duplicate Request',
|
|
'L_LONGMESSAGE0' => 'A successful transaction has already been completed for this token.',
|
|
'L_SEVERITYCODE0' => 'Warning',
|
|
'INSURANCEOPTIONSELECTED' => 'false',
|
|
'SHIPPINGOPTIONISDEFAULT' => 'false',
|
|
'PAYMENTINFO_0_TRANSACTIONID' => '5JE20141KL116573G',
|
|
'PAYMENTINFO_0_TRANSACTIONTYPE' => 'expresscheckout',
|
|
'PAYMENTINFO_0_PAYMENTTYPE' => 'instant',
|
|
'PAYMENTINFO_0_ORDERTIME' => '2019-09-30T22:20:57Z',
|
|
'PAYMENTINFO_0_AMT' => '31260.37',
|
|
'PAYMENTINFO_0_TAXAMT' => '0.00',
|
|
'PAYMENTINFO_0_CURRENCYCODE' => 'USD',
|
|
'PAYMENTINFO_0_EXCHANGERATE' => '0.692213615971749',
|
|
'PAYMENTINFO_0_PAYMENTSTATUS' => 'Pending',
|
|
'PAYMENTINFO_0_PENDINGREASON' => 'unilateral',
|
|
'PAYMENTINFO_0_REASONCODE' => 'None',
|
|
'PAYMENTINFO_0_PROTECTIONELIGIBILITY' => 'Ineligible',
|
|
'PAYMENTINFO_0_PROTECTIONELIGIBILITYTYPE' => 'None',
|
|
'PAYMENTINFO_0_ERRORCODE' => '0',
|
|
'PAYMENTINFO_0_ACK' => 'Success',
|
|
)
|
|
*/
|
|
class PayPalExpressPaymentDriver extends BasePaymentDriver
|
|
{
|
|
use MakesHash;
|
|
|
|
protected $refundable = true;
|
|
|
|
protected $token_billing = false;
|
|
|
|
protected $can_authorise_credit_card = false;
|
|
|
|
protected $customer_reference = '';
|
|
|
|
public function setPaymentMethod($payment_method_id = null)
|
|
{
|
|
return $this;
|
|
}
|
|
|
|
public function gatewayTypes()
|
|
{
|
|
return [
|
|
GatewayType::PAYPAL,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Processes the payment with this gateway.
|
|
*
|
|
*
|
|
* @param array $data variables required to build payment page
|
|
* @return void Gateway and payment method specific view
|
|
* @throws Exception
|
|
*/
|
|
public function processPaymentView(array $data)
|
|
{
|
|
$response = $this->purchase($this->paymentDetails($data), $this->paymentItems($data));
|
|
|
|
if ($response->isRedirect()) {
|
|
// redirect to offsite payment gateway
|
|
$response->redirect();
|
|
} elseif ($response->isSuccessful()) {
|
|
// payment was successful: update database
|
|
/* for this driver this method wont be hit*/
|
|
} else {
|
|
// payment failed: display message to customer
|
|
|
|
SystemLogger::dispatch(
|
|
[
|
|
'server_response' => $response->getData(),
|
|
'data' => $data,
|
|
],
|
|
SystemLog::CATEGORY_GATEWAY_RESPONSE,
|
|
SystemLog::EVENT_GATEWAY_FAILURE,
|
|
SystemLog::TYPE_PAYPAL,
|
|
$this->client
|
|
);
|
|
|
|
throw new Exception('Error Processing Payment', 1);
|
|
}
|
|
}
|
|
|
|
public function processPaymentResponse($request)
|
|
{
|
|
$response = $this->completePurchase($request->all());
|
|
|
|
$transaction_reference = $response->getTransactionReference() ?: $request->input('token');
|
|
|
|
if ($response->isCancelled()) {
|
|
return redirect()->route('client.invoices.index')->with('warning', ctrans('texts.status_cancelled'));
|
|
} elseif ($response->isSuccessful()) {
|
|
SystemLogger::dispatch(
|
|
[
|
|
'server_response' => $response->getData(),
|
|
'data' => $request->all(),
|
|
],
|
|
SystemLog::CATEGORY_GATEWAY_RESPONSE,
|
|
SystemLog::EVENT_GATEWAY_SUCCESS,
|
|
SystemLog::TYPE_PAYPAL,
|
|
$this->client
|
|
);
|
|
} elseif (! $response->isSuccessful()) {
|
|
PaymentFailureMailer::dispatch($this->client, $response->getMessage, $this->client->company, $response['PAYMENTINFO_0_AMT']);
|
|
|
|
SystemLogger::dispatch(
|
|
[
|
|
'data' => $request->all(),
|
|
'server_response' => $response->getData(),
|
|
],
|
|
SystemLog::CATEGORY_GATEWAY_RESPONSE,
|
|
SystemLog::EVENT_GATEWAY_FAILURE,
|
|
SystemLog::TYPE_PAYPAL,
|
|
$this->client
|
|
);
|
|
|
|
throw new Exception($response->getMessage());
|
|
}
|
|
|
|
$payment = $this->createPayment($response->getData());
|
|
$payment_hash = PaymentHash::whereRaw('BINARY `hash`= ?', [$request->input('payment_hash')])->firstOrFail();
|
|
|
|
$payment_hash->payment_id = $payment->id;
|
|
$payment_hash->save();
|
|
|
|
$this->attachInvoices($payment, $payment_hash);
|
|
$payment->service()->updateInvoicePayment($payment_hash);
|
|
|
|
event(new PaymentWasCreated($payment, $payment->company, Ninja::eventVars()));
|
|
|
|
return redirect()->route('client.payments.show', ['payment' => $this->encodePrimaryKey($payment->id)]);
|
|
}
|
|
|
|
protected function paymentDetails($input): array
|
|
{
|
|
$data = parent::paymentDetails($input);
|
|
|
|
$data['amount'] = $input['amount_with_fee'];
|
|
$data['returnUrl'] = $this->buildReturnUrl($input);
|
|
$data['cancelUrl'] = $this->buildCancelUrl($input);
|
|
$data['description'] = $this->buildDescription($input);
|
|
$data['transactionId'] = $this->buildTransactionId($input);
|
|
|
|
$data['ButtonSource'] = 'InvoiceNinja_SP';
|
|
$data['solutionType'] = 'Sole'; // show 'Pay with credit card' option
|
|
$data['transactionId'] = $data['transactionId'].'-'.time();
|
|
|
|
return $data;
|
|
}
|
|
|
|
private function buildReturnUrl($input): string
|
|
{
|
|
$url = $this->client->company->domain().'/client/payments/process/response';
|
|
$url .= "?company_gateway_id={$this->company_gateway->id}&gateway_type_id=".GatewayType::PAYPAL;
|
|
$url .= '&payment_hash='.$input['payment_hash'];
|
|
$url .= '&amount='.$input['amount'];
|
|
$url .= '&fee='.$input['fee'];
|
|
|
|
return $url;
|
|
}
|
|
|
|
private function buildCancelUrl($input): string
|
|
{
|
|
$url = $this->client->company->domain().'/client/invoices';
|
|
|
|
return $url;
|
|
}
|
|
|
|
private function buildDescription($input): string
|
|
{
|
|
$invoice_numbers = '';
|
|
|
|
foreach ($input['invoices'] as $invoice) {
|
|
$invoice_numbers .= $invoice->number.' ';
|
|
}
|
|
|
|
return ctrans('texts.invoice_number').": {$invoice_numbers}";
|
|
}
|
|
|
|
private function buildTransactionId($input): string
|
|
{
|
|
return implode(',', $input['hashed_ids']);
|
|
}
|
|
|
|
private function paymentItems($input): array
|
|
{
|
|
$items = [];
|
|
$total = 0;
|
|
|
|
foreach ($input['invoices'] as $invoice) {
|
|
foreach ($invoice->line_items as $invoiceItem) {
|
|
// Some gateways require quantity is an integer
|
|
if (floatval($invoiceItem->quantity) != intval($invoiceItem->quantity)) {
|
|
return null;
|
|
}
|
|
|
|
$item = new Item([
|
|
'name' => $invoiceItem->product_key,
|
|
'description' => substr($invoiceItem->notes, 0, 100),
|
|
'price' => $invoiceItem->cost,
|
|
'quantity' => $invoiceItem->quantity,
|
|
]);
|
|
|
|
$items[] = $item;
|
|
|
|
$total += $invoiceItem->cost * $invoiceItem->quantity;
|
|
}
|
|
}
|
|
|
|
if ($total != $input['amount_with_fee']) {
|
|
$item = new Item([
|
|
'name' => trans('texts.taxes_and_fees'),
|
|
'description' => '',
|
|
'price' => $input['amount_with_fee'] - $total,
|
|
'quantity' => 1,
|
|
]);
|
|
|
|
$items[] = $item;
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
public function createPayment($data, $status = Payment::STATUS_COMPLETED): Payment
|
|
{
|
|
$payment_meta = new stdClass;
|
|
$payment_meta->exp_month = 'xx';
|
|
$payment_meta->exp_year = 'xx';
|
|
$payment_meta->brand = 'PayPal';
|
|
$payment_meta->last4 = 'xxxx';
|
|
$payment_meta->type = GatewayType::PAYPAL;
|
|
|
|
$payment = parent::createPayment($data, $status);
|
|
|
|
$client_contact = $this->getContact();
|
|
$client_contact_id = $client_contact ? $client_contact->id : null;
|
|
|
|
$payment->amount = $data['PAYMENTINFO_0_AMT'];
|
|
$payment->type_id = PaymentType::PAYPAL;
|
|
$payment->transaction_reference = $data['PAYMENTINFO_0_TRANSACTIONID'];
|
|
$payment->client_contact_id = $client_contact_id;
|
|
$payment->meta = $payment_meta;
|
|
$payment->save();
|
|
|
|
return $payment;
|
|
}
|
|
|
|
public function refund(Payment $payment, $amount)
|
|
{
|
|
$this->gateway();
|
|
|
|
$response = $this->gateway
|
|
->refund(['transactionReference' => $payment->transaction_reference, 'amount' => $amount])
|
|
->send();
|
|
|
|
if ($response->isSuccessful()) {
|
|
SystemLogger::dispatch([
|
|
'server_response' => $response->getMessage(), 'data' => request()->all(),
|
|
], SystemLog::CATEGORY_GATEWAY_RESPONSE, SystemLog::EVENT_GATEWAY_SUCCESS, SystemLog::TYPE_PAYPAL, $this->client);
|
|
|
|
return [
|
|
'transaction_reference' => $response->getData()['REFUNDTRANSACTIONID'],
|
|
'transaction_response' => json_encode($response->getData()),
|
|
'success' => true,
|
|
'description' => $response->getData()['ACK'],
|
|
'code' => $response->getCode(),
|
|
];
|
|
}
|
|
|
|
SystemLogger::dispatch([
|
|
'server_response' => $response->getMessage(), 'data' => request()->all(),
|
|
], SystemLog::CATEGORY_GATEWAY_RESPONSE, SystemLog::EVENT_GATEWAY_FAILURE, SystemLog::TYPE_PAYPAL, $this->client);
|
|
|
|
return [
|
|
'transaction_reference' => $response->getData()['CORRELATIONID'],
|
|
'transaction_response' => json_encode($response->getData()),
|
|
'success' => false,
|
|
'description' => $response->getData()['L_LONGMESSAGE0'],
|
|
'code' => $response->getData()['L_ERRORCODE0'],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Detach payment method from PayPal.
|
|
*
|
|
* @param ClientGatewayToken $token
|
|
* @return void
|
|
*/
|
|
public function detach(ClientGatewayToken $token)
|
|
{
|
|
// PayPal doesn't support this feature.
|
|
}
|
|
}
|