Laravel Stripe – Stripe API integration

Projects Inventory

2 months ago

Integrating Stripe into your Laravel application allows you to accept payments seamlessly.

Step 1: Install Laravel Cashier

Laravel Cashier is a package that provides an interface for managing subscriptions and handling payments with Stripe. First, install Laravel Cashier:

bash

composer require laravel/cashier

1	composer require laravel/cashier

Step 2: Configure Stripe Credentials

You need to set up your Stripe API keys in your Laravel application. First, create a Stripe account at Stripe. Then, obtain your API keys from the Stripe Dashboard.

Open your .env file and add your Stripe API keys:

plaintext

STRIPE_KEY=your_stripe_public_key
STRIPE_SECRET=your_stripe_secret_key

1 2	STRIPE_KEY=your_stripe_public_key STRIPE_SECRET=your_stripe_secret_key

Step 3: Publish Cashier Configuration

Next, publish the Cashier configuration file using the following command:

bash

STRIPE_KEY=your_stripe_public_key
STRIPE_SECRET=your_stripe_secret_key

1 2	STRIPE_KEY=your_stripe_public_key STRIPE_SECRET=your_stripe_secret_key

This will create a config/cashier.php file, where you can configure additional settings if necessary.

Step 4: Set Up Database Migration

If you haven’t done so, you’ll need to add the required fields to your users table to store Stripe information. Run the migration command:

bash

php artisan migrate

1	php artisan migrate

You may need to create a new migration to add fields like stripe_id, card_brand, card_last_four, trial_ends_at, etc., to the users table.

Here’s an example migration:

bash

php artisan make:migration add_stripe_fields_to_users_table --table=users

1	php artisan make:migration add_stripe_fields_to_users_table --table=users

In the migration file, add the following code:

php

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('stripe_id')->nullable();
        $table->string('card_brand')->nullable();
        $table->string('card_last_four')->nullable();
        $table->timestamp('trial_ends_at')->nullable();
    });
}

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->dropColumn(['stripe_id', 'card_brand', 'card_last_four', 'trial_ends_at']);
    });
}

public function up()

{

Schema::table('users', function (Blueprint $table) {

$table->string('stripe_id')->nullable();

$table->string('card_brand')->nullable();

$table->string('card_last_four')->nullable();

$table->timestamp('trial_ends_at')->nullable();

});

}

public function down()

{

Schema::table('users', function (Blueprint $table) {

$table->dropColumn(['stripe_id', 'card_brand', 'card_last_four', 'trial_ends_at']);

});

}

Then run the migration:

bash

php artisan migrate

1	php artisan migrate

Step 5: Set Up Routes

Define routes for handling the payment process. Open routes/web.php and add the following routes:

php

use App\Http\Controllers\PaymentController;

Route::get('/payment', [PaymentController::class, 'index'])->name('payment.index');
Route::post('/payment', [PaymentController::class, 'store'])->name('payment.store');

use App\Http\Controllers\PaymentController;

Route::get('/payment', [PaymentController::class, 'index'])->name('payment.index');

Route::post('/payment', [PaymentController::class, 'store'])->name('payment.store');

Step 6: Create Payment Controller

Create a controller to handle the payment logic:

bash

php artisan make:controller PaymentController

1	php artisan make:controller PaymentController

In the PaymentController, add the following methods:

php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Stripe\Stripe;
use Stripe\Charge;

class PaymentController extends Controller
{
    public function index()
    {
        return view('payment.index');
    }

    public function store(Request $request)
    {
        // Validate request
        $request->validate([
            'amount' => 'required|numeric',
            'currency' => 'required|string',
            'stripeToken' => 'required|string',
        ]);

        // Set the Stripe secret key
        Stripe::setApiKey(env('STRIPE_SECRET'));

        try {
            // Create a charge
            Charge::create([
                'amount' => $request->amount * 100, // Amount in cents
                'currency' => $request->currency,
                'description' => 'Payment from Laravel App',
                'source' => $request->stripeToken,
                'receipt_email' => Auth::user()->email,
            ]);

            return redirect()->back()->with('success', 'Payment successful!');
        } catch (\Exception $e) {
            return redirect()->back()->with('error', $e->getMessage());
        }
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Illuminate\Support\Facades\Auth;

use Stripe\Stripe;

use Stripe\Charge;

class PaymentController extends Controller

{

public function index()

{

return view('payment.index');

}

public function store(Request $request)

{

// Validate request

$request->validate([

'amount' => 'required|numeric',

'currency' => 'required|string',

'stripeToken' => 'required|string',

]);

// Set the Stripe secret key

Stripe::setApiKey(env('STRIPE_SECRET'));

try {

// Create a charge

Charge::create([

'amount' => $request->amount * 100, // Amount in cents

'currency' => $request->currency,

'description' => 'Payment from Laravel App',

'source' => $request->stripeToken,

'receipt_email' => Auth::user()->email,

]);

return redirect()->back()->with('success', 'Payment successful!');

} catch (\Exception $e) {

return redirect()->back()->with('error', $e->getMessage());

}

Step 7: Create Payment Form

Create a Blade view for the payment form at resources/views/payment/index.blade.php:

html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Payment</title>
    <script src="https://js.stripe.com/v3/"></script>
</head>
<body>
    <h1>Payment</h1>

    @if (session('success'))
        <div>{{ session('success') }}</div>
    @endif

    @if (session('error'))
        <div>{{ session('error') }}</div>
    @endif

    <form action="{{ route('payment.store') }}" method="POST" id="payment-form">
        @csrf
        <input type="hidden" name="amount" value="10"> <!-- Amount in dollars -->
        <input type="hidden" name="currency" value="usd">

        <div>
            <label for="card-element">Credit or Debit Card</label>
            <div id="card-element"></div>
            <div id="card-errors" role="alert"></div>
        </div>

        <button type="submit">Submit Payment</button>
    </form>

    <script>
        var stripe = Stripe('{{ env('STRIPE_KEY') }}');
        var elements = stripe.elements();
        var cardElement = elements.create('card');
        cardElement.mount('#card-element');

        cardElement.on('change', function(event) {
            var displayError = document.getElementById('card-errors');
            if (event.error) {
                displayError.textContent = event.error.message;
            } else {
                displayError.textContent = '';
            }
        });

        var form = document.getElementById('payment-form');
        form.addEventListener('submit', function(event) {
            event.preventDefault();

            stripe.createToken(cardElement).then(function(result) {
                if (result.error) {
                    var errorElement = document.getElementById('card-errors');
                    errorElement.textContent = result.error.message;
                } else {
                    var hiddenInput = document.createElement('input');
                    hiddenInput.setAttribute('type', 'hidden');
                    hiddenInput.setAttribute('name', 'stripeToken');
                    hiddenInput.setAttribute('value', result.token.id);
                    form.appendChild(hiddenInput);
                    form.submit();
                }
            });
        });
    </script>
</body>
</html>

<!DOCTYPE html>

<head>

<title>Payment</title>

</head>

<body>

<h1>Payment</h1>

@if (session('success'))

<div>{{ session('success') }}</div>

@endif

@if (session('error'))

<div>{{ session('error') }}</div>

@endif

@csrf

<div>

<label for="card-element">Credit or Debit Card</label>

</div>

<button type="submit">Submit Payment</button>

</form>

var stripe = Stripe('{{ env('STRIPE_KEY') }}');

var elements = stripe.elements();

var cardElement = elements.create('card');

cardElement.mount('#card-element');

cardElement.on('change', function(event) {

var displayError = document.getElementById('card-errors');

if (event.error) {

displayError.textContent = event.error.message;

} else {

displayError.textContent = '';

}

});

var form = document.getElementById('payment-form');

form.addEventListener('submit', function(event) {

event.preventDefault();

stripe.createToken(cardElement).then(function(result) {

if (result.error) {

var errorElement = document.getElementById('card-errors');

errorElement.textContent = result.error.message;

} else {

var hiddenInput = document.createElement('input');

hiddenInput.setAttribute('type', 'hidden');

hiddenInput.setAttribute('name', 'stripeToken');

hiddenInput.setAttribute('value', result.token.id);

form.appendChild(hiddenInput);

form.submit();

}

});

</script>

</body>

</html>

Step 8: Testing

Visit the /payment

Advertisement

route in your browser.
Enter test card details. You can use the following test card numbers provided by Stripe:
- Visa: 4242 4242 4242 4242
- MasterCard: 4000 0025 0000 3155
- American Express: 3782 8224 6310 005
Submit the form. You should see a success message if the payment is processed successfully.

Step 9: Error Handling

Ensure to implement error handling for various scenarios, including network issues, payment failures, etc. You can customize the messages displayed to the user based on the exception received from Stripe.

Summary

You’ve successfully integrated Stripe API into your Laravel application! Here’s a quick recap of the steps:

Install Laravel Cashier.
Configure Stripe credentials in the .env file.
Publish Cashier configuration.
Set up the database migration to store Stripe information.
Create routes for handling payments.
Create a PaymentController to manage payment logic.
Create a payment form to collect payment details.
Test the integration using Stripe’s test card numbers.

Step 1: Install Laravel Cashier

Step 2: Configure Stripe Credentials

Step 3: Publish Cashier Configuration

Step 4: Set Up Database Migration

Step 5: Set Up Routes

Step 6: Create Payment Controller

Step 7: Create Payment Form

Step 8: Testing

Step 9: Error Handling

Summary

Related Posts: