README

Laravel Square

NOTE: This package is still in development and is not yet ready for production use. Use at your own risk.

This package is in active development, and will continue to be updated with new features and bug fixes. If you find a bug, please open an issue.

Square is a Payment Service Provider that offers a variety of services to help businesses accept payments. This package provides a simple way to integrate Square's payment gateway into your Laravel application.

We use the latest version of the Square API to provide you with the most up-to-date features and functionality.

Current API Version: 2024-11-20

Documentation

You can find the documentation in the docs/ directory. The documentation is written in Markdown and can be viewed in any text editor.

Installation

You can install the package via composer:

composer require elijahcruz/laravel-square

You can publish the config file with:

php artisan vendor:publish --tag="square-config"

Getting started

To get started you'll need to create a Square Account and create an application in the Square Developer Dashboard. You can find the Square Developer Dashboard here.

Using the package is simple. You can use the Square facade to access the Square API. Here's an example of how you can create a customer:

use Elijahcruz\Square\Facades\Square;

Square::customers()->create([
    'given_name' => 'John',
    'family_name' => 'Doe',
]);

Testing

We use Pest for testing. You can run the tests using the following command:

composer test

APIS

If a API is listed below without an x next to it, it means that the API is not yet implemented, but is being worked on, or is planned for the future.

Customers
Payments
Checkout
Invoices
Orders

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please review our security policy here.

Credits

License

The MIT License (MIT). Please see License File for more information.

elijahcruz / laravel-square

Maintainers

Details