PHPackages                             mboateng/sppay-laravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. mboateng/sppay-laravel

ActiveLibrary[Payment Processing](/categories/payments)

mboateng/sppay-laravel
======================

Laravel integration for the SPPay public API (payments, transfers, transactions, institutions, SMS).

1.0.1(3mo ago)03MITPHPPHP ^8.1

Since Mar 28Pushed 3mo agoCompare

[ Source](https://github.com/kudi-sandbox/kudi-package-sppay-laravel)[ Packagist](https://packagist.org/packages/mboateng/sppay-laravel)[ RSS](/packages/mboateng-sppay-laravel/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (4)Versions (5)Used By (0)

sppay-laravel
=============

[](#sppay-laravel)

Laravel client for the [SPPay](https://sppay.dev) public API: OAuth, payments, transfers, transactions, institutions, and SMS.

**Package:** `mboateng/sppay-laravel`
**PHP:** 8.1+
**Laravel:** 10, 11, or 12

Installation
------------

[](#installation)

```
composer require mboateng/sppay-laravel
```

The service provider and `Sppay` facade are registered automatically via Laravel package discovery.

Publish the configuration (optional):

```
php artisan vendor:publish --tag=sppay-config
```

Configuration
-------------

[](#configuration)

Values are read from `.env` through `config/sppay.php` (use `config('sppay.*')` in code).

### Environment variables

[](#environment-variables)

VariableDescriptionDefault`SPPAY_BASE_URL`API host, no trailing slash`https://engine.sppay.dev``SPPAY_OAUTH_URL`Full URL for token endpoint (optional)— (uses `{SPPAY_BASE_URL}/oauth/token`)`SPPAY_CLIENT_ID`OAuth client id—`SPPAY_CLIENT_SECRET`OAuth client secret—`SPPAY_USERNAME`OAuth username—`SPPAY_PASSWORD`OAuth password—`SPPAY_ACCESS_TOKEN`Bearer token (if you already have one)—`SPPAY_TIMEOUT`Request timeout (seconds)`30``SPPAY_CONNECT_TIMEOUT`Connect timeout (seconds)`10`Example `.env` (use your own secrets; do not commit real credentials):

```
SPPAY_BASE_URL=https://engine.sppay.dev
SPPAY_OAUTH_URL=https://engine.sppay.dev/oauth/token
SPPAY_CLIENT_ID=your-client-id
SPPAY_CLIENT_SECRET=your-client-secret
SPPAY_USERNAME=your@email.com
SPPAY_PASSWORD=your-password
```

Laravel loads these into `config('sppay.base_url')`, `config('sppay.oauth_url')`, `config('sppay.client_id')`, etc. You do not need a separate `services.php` entry unless you prefer to duplicate keys there.

Usage
-----

[](#usage)

### Facade

[](#facade)

**Option A — password grant using `.env` (recommended when credentials live in config):**

```
use Mboateng\Sppay\Facades\Sppay;

$response = Sppay::oauthPasswordGrant();
Sppay::setAccessToken($response['access_token']);

$transactions = Sppay::listTransactions(['page_size' => 10]);
```

**Option B — build the payload yourself:**

```
use Mboateng\Sppay\Facades\Sppay;

$token = Sppay::oauthToken([
    'grant_type' => 'password',
    'client_id' => config('sppay.client_id'),
    'client_secret' => config('sppay.client_secret'),
    'username' => config('sppay.username'),
    'password' => config('sppay.password'),
]);

Sppay::setAccessToken($token['access_token']);

$transactions = Sppay::listTransactions(['page_size' => 10]);
```

### Dependency injection

[](#dependency-injection)

```
use Mboateng\Sppay\Contracts\SppayClientContract;

public function __construct(
    private SppayClientContract $sppay
) {}

public function example(): void
{
    $this->sppay->setAccessToken($token);
    $this->sppay->getTransaction('REFERENCE');
}
```

### Manual client

[](#manual-client)

```
use Mboateng\Sppay\SppayClient;

$client = new SppayClient(
    baseUrl: 'https://engine.sppay.dev',
    accessToken: $token,
);

$client->initiatePayment([/* ... */]);
```

### Public endpoints (no Bearer)

[](#public-endpoints-no-bearer)

`oauthToken()` and `validatePublicKey()` do not send an `Authorization` header. All other methods require a Bearer token (`setAccessToken()` or `SPPAY_ACCESS_TOKEN`).

API methods
-----------

[](#api-methods)

MethodEndpoint`oauthToken(array $payload)``POST /oauth/token``oauthPasswordGrant()``POST /oauth/token` (uses `SPPAY_*` credentials from config)`validatePublicKey(array $body)``POST /v1/key/validate``validatePayment(array $body)``POST /v1/api/payments/validate``initiatePayment(array $body)``POST /v1/api/payments/initiate``submitPaymentOtp(array $body)``POST /v1/api/payments/otp/submit``validateTransferAccount(array $body)``POST /v1/api/transfers/validate-account``validateTransfer(array $body)``POST /v1/api/transfers/validate``submitTransfer(array $body)``POST /v1/api/transfers/submit``listTransactions(array $query)``GET /v1/api/transactions``getTransaction(string $reference)``GET /v1/api/transactions/{reference}``getTransactionStatus(string $reference)``GET /v1/api/transactions/{reference}/status``postSpPayWebhook(array $body)``POST /v1/sp-pay/webhook``getInstitutions(array $body)``POST /v1/api/institutions``getInstitution(string $code)``GET /v1/api/institutions/{code}``sendSms(array $body)``POST /v1/api/sms/send``listTransactions()` accepts query parameters such as `account_no`, `reference`, `amount`, `date_from`, `date_to`, `type_code`, `status_id`, `page_size`, `page`, etc.

Errors
------

[](#errors)

Failed HTTP calls throw `Mboateng\Sppay\Exceptions\SppayRequestException`. Use `getResponseBody()` for the raw API error body when available.

Testing
-------

[](#testing)

```
composer test
```

License
-------

[](#license)

MIT

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance82

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~183 days

Total

3

Last Release

97d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5520829?v=4)[mboateng](/maintainers/mboateng)[@mboateng](https://github.com/mboateng)

---

Top Contributors

[![hagios2](https://avatars.githubusercontent.com/u/31940634?v=4)](https://github.com/hagios2 "hagios2 (3 commits)")[![moaboateng](https://avatars.githubusercontent.com/u/38674372?v=4)](https://github.com/moaboateng "moaboateng (3 commits)")

---

Tags

laravelpaymentsapi clientmobile-moneyGhanasppay

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mboateng-sppay-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/mboateng-sppay-laravel/health.svg)](https://phpackages.com/packages/mboateng-sppay-laravel)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M3.1k](/packages/craftcms-cms)[sebdesign/laravel-viva-payments

A Laravel package for integrating the Viva Payments gateway

4851.0k](/packages/sebdesign-laravel-viva-payments)[simplestats-io/laravel-client

Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof.

5021.9k](/packages/simplestats-io-laravel-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)