dominservice/laravel-stripe-connect

2.1.0 2021-06-01 18:55 UTC

Requires

• php: >=7.1.3
• dominservice/data_locale_parser: ^1.0
• illuminate/database: ^6|^7|^8
• illuminate/support: ^6|^7|^8
• stripe/stripe-php: ^7.39

Requires (Dev)

• phpunit/phpunit: ^8.0|^9.0

MIT

• DSO-IT Mateusz Domin
• rap2h

• connect
• stripe
• laravel
• billing
• marketplace
• multivendor

README

Marketplaces and platforms use Stripe Connect to accept money and pay out to third parties. Connect provides a complete set of building blocks to support virtually any business model, including on-demand businesses, e‑commerce, crowdfunding, fintech, and travel and events.

Create a marketplace application with this helper for Stripe Connect.

Installation

Install via composer

composer require Dominservice/laravel-stripe-connect

Or place manually in composer.json:

"require": {
    "dominservice/conversations": "^1.0"
}

Run:

composer update

Add the service provider to config/app.php

'providers' => [
    Dominservice\LaravelStripeConnect\ServiceProvider::class,
],

(...)

'aliases' => [
    'StripeConnect' => Dominservice\LaravelStripeConnect\Facade\LaravelStripeConnectFacade::class,
]

Add your stripe credentials in .env:

STRIPE_KEY=pk_test_XxxXXxXXX
STRIPE_SECRET=sk_test_XxxXXxXXX

and made a call from the config/services.php as

'stripe' => [
  'model'  => App\User::class,
  'key'    => env('STRIPE_KEY'),
  'secret' => env('STRIPE_SECRET'),
],

Run migrations:

php artisan migrate

Version Compatibility

The following table shows which version to install. We have provided the Stripe API version that we developed against as guide. You may find the package works with older versions of the API.

Usage

You can make a single payment from a user to another user or save a customer card for later use. Just remember to import the base class via:

use Dominservice\LaravelStripeConnect\StripeConnect;

Exemple #3: create a vendor account

You may want to create the vendor account before charging anybody. Just call Account::create with a User instance. You make set params like stripe account object. If account nust be for company you make set company object

use Dominservice\LaravelStripeConnect\Repositories\Account;

(...)

$account = Account::create($vendor, $params = [], $company = false);

Example #1: direct charge

The customer gives his credentials via Stripe Checkout and is charged. It's a one shot process. $customer and $vendor must be User instances. The $token must have been created using Checkout or Elements.

StripeConnect::transaction($token)
    ->amount(1000, 'usd')
    ->from($customer)
    ->to($vendor, [], $company ?? false)
    ->create();

Example #2: save a customer then charge later

Sometimes, you may want to register a card then charge later. First, create the customer.

StripeConnect::createCustomer($token, $customer);

Then, (later) charge the customer without token.

StripeConnect::transaction()
    ->amount(1000, 'usd')
    ->useSavedCustomer()
    ->from($customer)
    ->to($vendor, $params = [], $company = false)
    ->create(); 

Exemple #3: create a vendor account

You may want to create the vendor account before charging anybody. Just call createAccount with a User instance.

StripeConnect::createAccount($vendor);

Exemple #4: Charge with application fee

StripeConnect::transaction($token)
    ->amount(1000, 'usd', 50)
    ->from($customer)
    ->to($vendor, $params = [], $company = false)
    ->create(); 

Example #5 Session checkout

Fee have 2 parameters $amount and $isPercent. You make set multi products usint multiple product() method. This method has 4 parameters $name, $amount, $quantity and $currency On default $currency is taked from $vendor stripe info and $quantity = 1 $amount must be a float type

 $sessionCheckout = new Checkout;
 $session = $sessionCheckout->vendor(auth()->user())
   ->destinationCharges()
   ->serReferenceTransaction($order->reference_number)
   ->customer($user)
   ->product(__('orders.transaction.name', [
     'days' => $days,
     'project' => $projectName,
     'campaign' => $campaignName,
   ]), $amount)
   ->fee(10, true)
   ->successUrl(route('orders.paymentSuccess', ['uuid'=>$order->uuid]))
   ->cancelUrl(route('orders.checkout', ['uuid'=>$order->uuid]))
   ->create();

User object must have:

$vendor = User:: (object) [
    'first_name' => 'Zenon',
    'last_name' => 'Burczymucha',
    'phone' => '[phone]',
    'email' => '[e-mail]',
    'country' => 'PL',
];

Company object must have:

$vendorCompany = Company:: (object) [
    'city' => 'Warszawa',
    'address' => 'Zatyna 12',
    'address_2' => '',
    'postcode' => '01-000',
    'state' => 'Mazowieckie',
    'name' => 'Firma Testowa',
    'phone' => '[phone]',
    'tax_no_prefix' => 'PL',
    'tax_no' => '0123456789',
    'country' => 'PL',
];

Contributing

We have only implemented the repositories for the Stripe resources we are using in our application.

If you find this package is missing a resource you need in your application, an ideal way to contribute is to submit a pull request to add the missing repository.