Laravel Galax Pay

Make requests to the Galax Pay API

Installation

Step 1. Add Laravel Galax Pay to your project:

composer require josan-br/laravel-galax-pay

Step 2. Register GalaxPayServiceProvider:

• In Laravel:

  'providers' => [
      // ...
      \JosanBr\GalaxPay\Providers\GalaxPayServiceProvider::class,
  ];
  

• In Lumen, go to the bootstrap/app.php file and in the providers section add:

  $app->register(\JosanBr\GalaxPay\Providers\GalaxPayServiceProvider::class);
  

Step 3. Publish files:

php artisan galax-pay:publish

This command allows publishing the settings and migrations, before publishing the migrations publish the settings.

The command doesn't publish both at once because you might want to use other tables than the ones the package provides.

In this case, just go to config/galax_pay.php and define the models you want to use and the referring columns.

// ...
'galax_pay_clients' => [
    'model'      => \JosanBr\GalaxPay\Models\GalaxPayClient::class,
    // Columns
    'entity'     => 'entity',
    'entity_id'  => 'entity_id',
    'galax_id'   => 'galax_id',
    'galax_hash' => 'galax_hash',
],

'galax_pay_sessions' => [
    'model'        => \JosanBr\GalaxPay\Models\GalaxPaySession::class,
    // Columns
    'scope'        => 'scope',
    'expires_in'   => 'expires_in',
    'token_type'   => 'token_type',
    'access_token' => 'access_token',
    'client_id'    => 'galax_pay_client_id',
]

Step 4. add environment variables:

GALAX_PAY_ENV=
GALAX_PAY_URL_PRODUCTION=
GALAX_PAY_URL_SANDBOX=
GALAX_PAY_AUTH_AS_PARTNER=
GALAX_PAY_ID=
GALAX_PAY_HASH=
GALAX_PAY_WEBHOOK_HASH=
GALAX_PAY_SESSION_DRIVER=

Usage

Use the Galax Pay facades class

use JosanBr\GalaxPay\Facades\GalaxPay;

If using standard authentication, auth_as_partner = false, just call an endpoint as static function:

$data = GalaxPay::listCustomers();

If using partner authentication auth_as_partner = true, you must inform which client credentials will be used, for this do:

GalaxPay::switchClientInSession($clientId);

After that call the endpoint:

$data = GalaxPay::listCustomers();

You can see the available endpoints here.

All endpoints receive a single array type function parameter, in the following format:

$data = GalaxPay::endpointName([
    /**
     * Parameters in the uri path
     */
    'params' => ['customerId' => '', 'typeId' => ''],

    /**
     * To pass parameters in the URL use the QueryParams class,
     * which takes an array of parameters.
     *
     * NOTE: Use only on data fetch endpoints
     */
    'query' => new \JosanBr\GalaxPay\QueryParams($params),
    // or use the GalaxPay Facade
    'query' => GalaxPay::queryParams($params),

    /**
     * Data to send to galax pay, can be an array or one of
     * the models available in \JosanBr\GalaxPay\Models,
     * with the exception of GalaxPayClient and GalaxPaySession
     */
    'data' => [],
]);

The QueryParams class only has the common parameters between the data fetching endpoints, but you can pass specific parameters normally that will be used.

To see the parameters that each endpoint accepts, go to Galax Pay documentation.