mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
532 lines
17 KiB
PHP
532 lines
17 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://opensource.org/licenses/AAL
|
|
*/
|
|
|
|
namespace App\PaymentDrivers;
|
|
|
|
use App\Factory\PaymentFactory;
|
|
use App\Http\Requests\Payments\PaymentWebhookRequest;
|
|
use App\Http\Requests\Request;
|
|
use App\Jobs\Util\SystemLogger;
|
|
use App\Models\ClientGatewayToken;
|
|
use App\Models\GatewayType;
|
|
use App\Models\Payment;
|
|
use App\Models\PaymentHash;
|
|
use App\Models\SystemLog;
|
|
use App\PaymentDrivers\Stripe\ACH;
|
|
use App\PaymentDrivers\Stripe\Alipay;
|
|
use App\PaymentDrivers\Stripe\Charge;
|
|
use App\PaymentDrivers\Stripe\CreditCard;
|
|
use App\PaymentDrivers\Stripe\ImportCustomers;
|
|
use App\PaymentDrivers\Stripe\SOFORT;
|
|
use App\PaymentDrivers\Stripe\UpdatePaymentMethods;
|
|
use App\PaymentDrivers\Stripe\Utilities;
|
|
use App\Utils\Traits\MakesHash;
|
|
use Exception;
|
|
use Illuminate\Support\Carbon;
|
|
use Stripe\Account;
|
|
use Stripe\Customer;
|
|
use Stripe\Exception\ApiErrorException;
|
|
use Stripe\PaymentIntent;
|
|
use Stripe\PaymentMethod;
|
|
use Stripe\SetupIntent;
|
|
use Stripe\Stripe;
|
|
use Stripe\StripeClient;
|
|
|
|
class StripePaymentDriver extends BaseDriver
|
|
{
|
|
use MakesHash, Utilities;
|
|
|
|
public $refundable = true;
|
|
|
|
public $token_billing = true;
|
|
|
|
public $can_authorise_credit_card = true;
|
|
|
|
/** @var \Stripe\StripeClient */
|
|
public $stripe;
|
|
|
|
protected $customer_reference = 'customerReferenceParam';
|
|
|
|
public $payment_method;
|
|
|
|
public $stripe_connect = false;
|
|
|
|
public $stripe_connect_auth = [];
|
|
|
|
public static $methods = [
|
|
GatewayType::CREDIT_CARD => CreditCard::class,
|
|
GatewayType::BANK_TRANSFER => ACH::class,
|
|
GatewayType::ALIPAY => Alipay::class,
|
|
GatewayType::SOFORT => SOFORT::class,
|
|
GatewayType::APPLE_PAY => 1, // TODO
|
|
GatewayType::SEPA => 1, // TODO
|
|
];
|
|
|
|
const SYSTEM_LOG_TYPE = SystemLog::TYPE_STRIPE;
|
|
|
|
/**
|
|
* Initializes the Stripe API.
|
|
* @return void
|
|
*/
|
|
public function init(): void
|
|
{
|
|
if($this->stripe_connect)
|
|
{
|
|
Stripe::setApiKey(config('ninja.ninja_stripe_key'));
|
|
|
|
$this->stripe_connect_auth = ["stripe_account" => $this->company_gateway->getConfigField('account_id')];
|
|
}
|
|
else
|
|
{
|
|
$this->stripe = new StripeClient(
|
|
$this->company_gateway->getConfigField('apiKey')
|
|
);
|
|
|
|
Stripe::setApiKey($this->company_gateway->getConfigField('apiKey'));
|
|
|
|
}
|
|
}
|
|
|
|
public function setPaymentMethod($payment_method_id)
|
|
{
|
|
$class = self::$methods[$payment_method_id];
|
|
|
|
$this->payment_method = new $class($this);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns the gateway types.
|
|
*/
|
|
public function gatewayTypes(): array
|
|
{
|
|
$types = [
|
|
GatewayType::CREDIT_CARD,
|
|
GatewayType::CRYPTO,
|
|
// GatewayType::SEPA, // TODO: Missing implementation
|
|
// GatewayType::APPLE_PAY, // TODO:: Missing implementation
|
|
];
|
|
|
|
if ($this->client
|
|
&& isset($this->client->country)
|
|
&& in_array($this->client->country->iso_3166_3, ['AUT', 'BEL', 'DEU', 'ITA', 'NLD', 'ESP'])) {
|
|
$types[] = GatewayType::SOFORT;
|
|
}
|
|
|
|
if ($this->client
|
|
&& isset($this->client->country)
|
|
&& in_array($this->client->country->iso_3166_3, ['USA'])) {
|
|
$types[] = GatewayType::BANK_TRANSFER;
|
|
}
|
|
|
|
if ($this->client
|
|
&& isset($this->client->country)
|
|
&& in_array($this->client->country->iso_3166_3, ['AUS', 'DNK', 'DEU', 'ITA', 'LUX', 'NOR', 'SVN', 'GBR', 'AUT', 'EST', 'GRC', 'JPN', 'MYS', 'PRT', 'ESP', 'USA', 'BEL', 'FIN', 'HKG', 'LVA', 'NLD', 'SGP', 'SWE', 'CAN', 'FRA', 'IRL', 'LTU', 'NZL', 'SVK', 'CHE'])) {
|
|
$types[] = GatewayType::ALIPAY;
|
|
}
|
|
|
|
return $types;
|
|
}
|
|
|
|
public function viewForType($gateway_type_id)
|
|
{
|
|
switch ($gateway_type_id) {
|
|
case GatewayType::CREDIT_CARD:
|
|
return 'gateways.stripe.credit_card';
|
|
break;
|
|
case GatewayType::SOFORT:
|
|
return 'gateways.stripe.sofort';
|
|
break;
|
|
case GatewayType::BANK_TRANSFER:
|
|
return 'gateways.stripe.ach';
|
|
break;
|
|
case GatewayType::SEPA:
|
|
return 'gateways.stripe.sepa';
|
|
break;
|
|
case GatewayType::CRYPTO:
|
|
case GatewayType::ALIPAY:
|
|
case GatewayType::APPLE_PAY:
|
|
return 'gateways.stripe.other';
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
public function getClientRequiredFields(): array
|
|
{
|
|
$fields = [
|
|
['name' => 'client_postal_code', 'label' => ctrans('texts.postal_code'), 'type' => 'text', 'validation' => 'required'],
|
|
];
|
|
|
|
if ($this->company_gateway->require_client_name) {
|
|
$fields[] = ['name' => 'client_name', 'label' => ctrans('texts.client_name'), 'type' => 'text', 'validation' => 'required'];
|
|
}
|
|
|
|
if ($this->company_gateway->require_client_phone) {
|
|
$fields[] = ['name' => 'client_phone', 'label' => ctrans('texts.client_phone'), 'type' => 'tel', 'validation' => 'required'];
|
|
}
|
|
|
|
if ($this->company_gateway->require_contact_name) {
|
|
$fields[] = ['name' => 'contact_first_name', 'label' => ctrans('texts.first_name'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'contact_last_name', 'label' => ctrans('texts.last_name'), 'type' => 'text', 'validation' => 'required'];
|
|
}
|
|
|
|
if ($this->company_gateway->require_contact_email) {
|
|
$fields[] = ['name' => 'contact_email', 'label' => ctrans('texts.email'), 'type' => 'text', 'validation' => 'required,email:rfc'];
|
|
}
|
|
|
|
if ($this->company_gateway->require_billing_address) {
|
|
$fields[] = ['name' => 'client_address_line_1', 'label' => ctrans('texts.address1'), 'type' => 'text', 'validation' => 'required'];
|
|
// $fields[] = ['name' => 'client_address_line_2', 'label' => ctrans('texts.address2'), 'type' => 'text', 'validation' => 'nullable'];
|
|
$fields[] = ['name' => 'client_city', 'label' => ctrans('texts.city'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'client_state', 'label' => ctrans('texts.state'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'client_country_id', 'label' => ctrans('texts.country'), 'type' => 'text', 'validation' => 'required'];
|
|
}
|
|
|
|
if ($this->company_gateway->require_shipping_address) {
|
|
$fields[] = ['name' => 'client_shipping_address_line_1', 'label' => ctrans('texts.shipping_address1'), 'type' => 'text', 'validation' => 'required'];
|
|
// $fields[] = ['name' => 'client_shipping_address_line_2', 'label' => ctrans('texts.shipping_address2'), 'type' => 'text', 'validation' => 'sometimes'];
|
|
$fields[] = ['name' => 'client_shipping_city', 'label' => ctrans('texts.shipping_city'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'client_shipping_state', 'label' => ctrans('texts.shipping_state'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'client_shipping_postal_code', 'label' => ctrans('texts.shipping_postal_code'), 'type' => 'text', 'validation' => 'required'];
|
|
$fields[] = ['name' => 'client_shipping_country_id', 'label' => ctrans('texts.shipping_country'), 'type' => 'text', 'validation' => 'required'];
|
|
}
|
|
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* Proxy method to pass the data into payment method authorizeView().
|
|
*
|
|
* @param array $data
|
|
* @return \Illuminate\Http\RedirectResponse|mixed
|
|
*/
|
|
public function authorizeView(array $data)
|
|
{
|
|
return $this->payment_method->authorizeView($data);
|
|
}
|
|
|
|
/**
|
|
* Processes the gateway response for credit card authorization.
|
|
*
|
|
* @param \Illuminate\Http\Request $request
|
|
* @return \Illuminate\Http\RedirectResponse|mixed
|
|
*/
|
|
public function authorizeResponse($request)
|
|
{
|
|
return $this->payment_method->authorizeResponse($request);
|
|
}
|
|
|
|
/**
|
|
* Process the payment with gateway.
|
|
*
|
|
* @param array $data
|
|
* @return \Illuminate\Http\RedirectResponse|mixed
|
|
*/
|
|
public function processPaymentView(array $data)
|
|
{
|
|
return $this->payment_method->paymentView($data);
|
|
}
|
|
|
|
public function processPaymentResponse($request)
|
|
{
|
|
return $this->payment_method->paymentResponse($request);
|
|
}
|
|
|
|
/**
|
|
* Creates a new String Payment Intent.
|
|
*
|
|
* @param array $data The data array to be passed to Stripe
|
|
* @return PaymentIntent The Stripe payment intent object
|
|
* @throws ApiErrorException
|
|
*/
|
|
public function createPaymentIntent($data): ?PaymentIntent
|
|
{
|
|
$this->init();
|
|
|
|
$meta = $this->stripe_connect_auth;
|
|
|
|
return PaymentIntent::create($data, $meta);
|
|
}
|
|
|
|
/**
|
|
* Returns a setup intent that allows the user
|
|
* to enter card details without initiating a transaction.
|
|
*
|
|
* @return SetupIntent
|
|
* @throws ApiErrorException
|
|
*/
|
|
public function getSetupIntent(): SetupIntent
|
|
{
|
|
$this->init();
|
|
|
|
$params = [];
|
|
$meta = $this->stripe_connect_auth;
|
|
|
|
return SetupIntent::create($params, $meta);
|
|
}
|
|
|
|
/**
|
|
* Returns the Stripe publishable key.
|
|
* @return null|string The stripe publishable key
|
|
*/
|
|
public function getPublishableKey(): ?string
|
|
{
|
|
return $this->company_gateway->getPublishableKey();
|
|
}
|
|
|
|
/**
|
|
* Finds or creates a Stripe Customer object.
|
|
*
|
|
* @return null|Customer A Stripe customer object
|
|
* @throws \Laracasts\Presenter\Exceptions\PresenterException
|
|
* @throws ApiErrorException
|
|
*/
|
|
public function findOrCreateCustomer(): ?Customer
|
|
{
|
|
$customer = null;
|
|
|
|
$this->init();
|
|
|
|
$client_gateway_token = ClientGatewayToken::whereClientId($this->client->id)->whereCompanyGatewayId($this->company_gateway->id)->first();
|
|
|
|
if ($client_gateway_token && $client_gateway_token->gateway_customer_reference) {
|
|
$customer = Customer::retrieve($client_gateway_token->gateway_customer_reference, $this->stripe_connect_auth);
|
|
} else {
|
|
|
|
$data['name'] = $this->client->present()->name();
|
|
$data['phone'] = $this->client->present()->phone();
|
|
|
|
if (filter_var($this->client->present()->email(), FILTER_VALIDATE_EMAIL)) {
|
|
$data['email'] = $this->client->present()->email();
|
|
}
|
|
|
|
$customer = Customer::create($data, $this->stripe_connect_auth);
|
|
}
|
|
|
|
if (!$customer) {
|
|
throw new Exception('Unable to create gateway customer');
|
|
}
|
|
|
|
return $customer;
|
|
}
|
|
|
|
public function refund(Payment $payment, $amount, $return_client_response = false)
|
|
{
|
|
$this->init();
|
|
|
|
$meta = $this->stripe_connect_auth;
|
|
|
|
/** Response from Stripe SDK/API. */
|
|
$response = null;
|
|
|
|
try {
|
|
$response = $this->stripe
|
|
->refunds
|
|
->create(['charge' => $payment->transaction_reference, 'amount' => $this->convertToStripeAmount($amount, $this->client->currency()->precision)], $meta);
|
|
|
|
if ($response->status == $response::STATUS_SUCCEEDED) {
|
|
SystemLogger::dispatch(['server_response' => $response, 'data' => request()->all(),], SystemLog::CATEGORY_GATEWAY_RESPONSE, SystemLog::EVENT_GATEWAY_SUCCESS, SystemLog::TYPE_STRIPE, $this->client, $this->client->company);
|
|
|
|
return [
|
|
'transaction_reference' => $response->charge,
|
|
'transaction_response' => json_encode($response),
|
|
'success' => $response->status == $response::STATUS_SUCCEEDED ? true : false,
|
|
'description' => $response->metadata,
|
|
'code' => $response,
|
|
];
|
|
}
|
|
|
|
SystemLogger::dispatch(['server_response' => $response, 'data' => request()->all(),], SystemLog::CATEGORY_GATEWAY_RESPONSE, SystemLog::EVENT_GATEWAY_FAILURE, SystemLog::TYPE_STRIPE, $this->client, $this->client->company);
|
|
|
|
return [
|
|
'transaction_reference' => null,
|
|
'transaction_response' => json_encode($response),
|
|
'success' => false,
|
|
'description' => $response->failure_reason,
|
|
'code' => 422,
|
|
];
|
|
} catch (Exception $e) {
|
|
SystemLogger::dispatch(['server_response' => $response, 'data' => request()->all(),], SystemLog::CATEGORY_GATEWAY_RESPONSE, SystemLog::EVENT_GATEWAY_FAILURE, SystemLog::TYPE_STRIPE, $this->client, $this->client->company);
|
|
|
|
nlog($e->getMessage());
|
|
|
|
return [
|
|
'transaction_reference' => null,
|
|
'transaction_response' => json_encode($response),
|
|
'success' => false,
|
|
'description' => $e->getMessage(),
|
|
'code' => 422,
|
|
];
|
|
}
|
|
}
|
|
|
|
public function verificationView(ClientGatewayToken $payment_method)
|
|
{
|
|
return $this->payment_method->verificationView($payment_method);
|
|
}
|
|
|
|
public function processVerification(Request $request, ClientGatewayToken $payment_method)
|
|
{
|
|
return $this->payment_method->processVerification($request, $payment_method);
|
|
}
|
|
|
|
public function processWebhookRequest(PaymentWebhookRequest $request, Payment $payment)
|
|
{
|
|
if ($request->type == 'source.chargeable') {
|
|
$payment->status_id = Payment::STATUS_COMPLETED;
|
|
$payment->save();
|
|
}
|
|
|
|
if ($request->type == 'charge.succeeded') {
|
|
$payment->status_id = Payment::STATUS_COMPLETED;
|
|
$payment->save();
|
|
}
|
|
|
|
// charge.failed, charge.refunded
|
|
|
|
return response([], 200);
|
|
}
|
|
|
|
public function tokenBilling(ClientGatewayToken $cgt, PaymentHash $payment_hash)
|
|
{
|
|
return (new Charge($this))->tokenBilling($cgt, $payment_hash);
|
|
}
|
|
|
|
/**
|
|
* Attach Stripe payment method to Stripe client.
|
|
*
|
|
* @param string $payment_method
|
|
* @param mixed $customer
|
|
*
|
|
* @return void
|
|
*/
|
|
public function attach(string $payment_method, $customer): void
|
|
{
|
|
$this->init();
|
|
|
|
try {
|
|
|
|
$stripe_payment_method = $this->getStripePaymentMethod($payment_method);
|
|
$stripe_payment_method->attach(['customer' => $customer->id], $this->stripe_connect_auth);
|
|
|
|
} catch (ApiErrorException | Exception $e) {
|
|
|
|
nlog($e->getMessage());
|
|
|
|
SystemLogger::dispatch([
|
|
'server_response' => $e->getMessage(),
|
|
'data' => request()->all(),
|
|
],
|
|
SystemLog::CATEGORY_GATEWAY_RESPONSE,
|
|
SystemLog::EVENT_GATEWAY_FAILURE,
|
|
SystemLog::TYPE_STRIPE,
|
|
$this->client, $this->client->company);
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Detach payment method from the Stripe.
|
|
* https://stripe.com/docs/api/payment_methods/detach
|
|
*
|
|
* @param ClientGatewayToken $token
|
|
* @return void
|
|
*/
|
|
public function detach(ClientGatewayToken $token)
|
|
{
|
|
|
|
$this->init();
|
|
|
|
try{
|
|
|
|
$pm = $this->getStripePaymentMethod($token->token);
|
|
$pm->detach([], $this->stripe_connect_auth);
|
|
|
|
} catch (ApiErrorException | Exception $e) {
|
|
|
|
nlog($e->getMessage());
|
|
|
|
SystemLogger::dispatch([
|
|
'server_response' => $e->getMessage(),
|
|
'data' => request()->all(),
|
|
],
|
|
SystemLog::CATEGORY_GATEWAY_RESPONSE,
|
|
SystemLog::EVENT_GATEWAY_FAILURE,
|
|
SystemLog::TYPE_STRIPE,
|
|
$this->client, $this->client->company);
|
|
|
|
}
|
|
}
|
|
|
|
public function getCompanyGatewayId(): int
|
|
{
|
|
return $this->company_gateway->id;
|
|
}
|
|
|
|
/**
|
|
* Retrieve payment method from Stripe.
|
|
*
|
|
* @param string $source
|
|
*
|
|
* @return PaymentMethod|void
|
|
*/
|
|
public function getStripePaymentMethod(string $source)
|
|
{
|
|
try {
|
|
|
|
return PaymentMethod::retrieve($source, $this->stripe_connect_auth);
|
|
|
|
} catch (ApiErrorException | Exception $e) {
|
|
|
|
return $this->processInternallyFailedPayment($this, $e);
|
|
|
|
}
|
|
}
|
|
|
|
public function getAllConnectedAccounts()
|
|
{
|
|
$this->init();
|
|
|
|
return Account::all();
|
|
}
|
|
|
|
/**
|
|
* Pull all client payment methods and update
|
|
* the respective tokens in the system.
|
|
*
|
|
*/
|
|
// public function updateAllPaymentMethods()
|
|
// {
|
|
// return (new UpdatePaymentMethods($this))->run();
|
|
// }
|
|
|
|
/**
|
|
* Imports stripe customers and their payment methods
|
|
* Matches users in the system based on the $match_on_record
|
|
* ie. email
|
|
*
|
|
* Phone
|
|
* Email
|
|
*/
|
|
public function importCustomers()
|
|
{
|
|
|
|
return (new ImportCustomers($this))->run();
|
|
//match clients based on the gateway_customer_reference column
|
|
|
|
}
|
|
}
|