PHPackages                             zeevx/laravel-ovalfi - 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. zeevx/laravel-ovalfi

ActiveLibrary

zeevx/laravel-ovalfi
====================

A Laravel Package for OvalFi - https://dev.ovalfi-app.com/

0.1.2(3y ago)26MITPHPPHP ^7.4|^8.0

Since Aug 25Pushed 3y ago1 watchersCompare

[ Source](https://github.com/zeevx/laravel-ovalfi)[ Packagist](https://packagist.org/packages/zeevx/laravel-ovalfi)[ Docs](https://github.com/zeevx/laravel-ovalfi)[ RSS](/packages/zeevx-laravel-ovalfi/feed)WikiDiscussions master Synced 1mo ago

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

 [![](https://camo.githubusercontent.com/ba20ea62c2dbe4bbd313d48fc6be2a4a15b3cd766cac9975675304c83ae008e7/68747470733a2f2f6d69726f2e6d656469756d2e636f6d2f6d61782f313430302f312a4f3678395579785f734c7356364f75576e5f495555772e706e67 "ovalFi")](https://camo.githubusercontent.com/ba20ea62c2dbe4bbd313d48fc6be2a4a15b3cd766cac9975675304c83ae008e7/68747470733a2f2f6d69726f2e6d656469756d2e636f6d2f6d61782f313430302f312a4f3678395579785f734c7356364f75576e5f495555772e706e67)

OvalFi Laravel Package
----------------------

[](#ovalfi-laravel-package)

Laravel-OvalFi helps you Set up, test, and manage your OvalFi integration directly in your Laravel App.

[![Latest Version on Packagist](https://camo.githubusercontent.com/47546a57879b94c14fe74d8d7387b4ade035890a864053f8243e88ff9be20279/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7a656576782f6c61726176656c2d6f76616c66692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/zeevx/laravel-ovalfi)[![Total Downloads](https://camo.githubusercontent.com/be63bff0a10c13b0d3471afc33b2160c88e2bfef46e4890adb76002d58c0c312/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7a656576782f6c61726176656c2d6f76616c66692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/zeevx/laravel-ovalfi)[![GitHub Actions](https://github.com/zeevx/laravel-ovalfi/actions/workflows/main.yml/badge.svg)](https://github.com/zeevx/laravel-ovalfi/actions/workflows/main.yml/badge.svg)

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

[](#installation)

You can install the package via composer:

```
composer require zeevx/laravel-ovalfi
```

After installation, run (to create the ovalfi.php config file):

```
php artisan ovalfi:publish
```

Add the following to your .env, you can get these values from your ovalfi dashboard:

#### NB: OVALFI\_MODE should be set to *sandbox* for testing and *live* for production.

[](#nb-ovalfi_mode-should-be-set-to-sandbox-for-testing-and-live-for-production)

```
OVALFI_MODE=
OVALFI_PUBLIC_KEY=
OVALFI_BEARER_TOKEN=
```

Usage:
------

[](#usage)

### Use the helper function

[](#use-the-helper-function)

```
ovalfi() //It works automatically 😍
```

### Create customer

[](#create-customer)

```
ovalfi()->createCustomer(
        string $name,
        string $mobile_number,
        string $email,
        string $reference,
        string $yield_offering_id
        );
```

### Update customer

[](#update-customer)

```
ovalfi()->updateCustomer(
        string $customer_id,
        string $name = null,
        string $mobile_number = null,
        string $email = null,
        string $reference = null,
        string $yield_offering_id = null
    );
```

### Get customers

[](#get-customers)

```
ovalfi()->getCustomers();
```

### Get customer

[](#get-customer)

```
ovalfi()->getCustomer(
        string $customer_id
    );
```

### Get exchange rate

[](#get-exchange-rate)

```
ovalfi()->getExchangeRate(
        float $amount,
        string $currency,
        string $destination_currency
    );
```

### Initiate transfer

[](#initiate-transfer)

NB: Please check this doc to understand the parameters better:

```
ovalfi()->initiateTransfer(
        string $customer_id,
        float $amount,
        string $currency,
        array $destination,
        string $reason,
        string $reference,
        string $note = null
    );
```

### Cancel transfer by batch ID

[](#cancel-transfer-by-batch-id)

```
ovalfi()->cancelTransferByBatchId(
        string $batch_id,
        string $reason
    );
```

### Get business portfolios

[](#get-business-portfolios)

```
ovalfi()->getBusinessPortfolios();
```

### Create yield offering profile

[](#create-yield-offering-profile)

```
ovalfi()->createYieldOfferingProfile(
        string $name,
        string $reference,
        string $description,
        string $portfolio_id = null,
        float $apy_rate = null,
        string $currency = null,
        int $deposit_lock_day = null,
        float $minimum_deposit_allowed = null,
        float $maximum_deposit_allowed = null,
        int $yieldable_after_day = null,
        float $withdrawal_limit_rate = null
    );
```

### Get yield profiles

[](#get-yield-profiles)

```
ovalfi()->getYieldProfiles();
```

### Get yield profile

[](#get-yield-profile)

```
ovalfi()->getYieldProfile(
        string $yield_offering_id
    );
```

### Update yield offering profile

[](#update-yield-offering-profile)

```
ovalfi()->updateYieldOfferingProfile(
        string $yield_offering_id,
        string $name = null,
        string $reference = null,
        string $description = null,
        string $portfolio_id = null,
        float $apy_rate = null,
        string $currency = null,
        int $deposit_lock_day = null,
        float $minimum_deposit_allowed = null,
        float $maximum_deposit_allowed = null,
        int $yieldable_after_day = null,
        float $withdrawal_limit_rate = null
    );
```

### Get customer balance

[](#get-customer-balance)

```
ovalfi()->getCustomerBalance(
        string $customer_id
    );
```

### Initiate savings deposit

[](#initiate-savings-deposit)

```
ovalfi()->initiateSavingsDeposit(
        string $customer_id,
        string $reference,
        float $amount
    );
```

### Get deposits

[](#get-deposits)

```
ovalfi()->getDeposits();
```

### Get deposit by batch ID

[](#get-deposit-by-batch-id)

```
ovalfi()->getDepositByBatchId(
        string $batch_id
    );
```

### Initiate savings withdrawal

[](#initiate-savings-withdrawal)

```
ovalfi()->initiateSavingsWithdrawal(
        string $customer_id,
        string $reference,
        float $amount
    );
```

### Security

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Paul Adams](https://github.com/zeevx)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~0 days

Total

3

Last Release

1356d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/89e891f62dbee3c7f6979348f5e75af5b72267a9160456918e63f80092281ff4?d=identicon)[zeevx](/maintainers/zeevx)

---

Top Contributors

[![zeevx](https://avatars.githubusercontent.com/u/44035730?v=4)](https://github.com/zeevx "zeevx (5 commits)")

---

Tags

zeevxlaravel-ovalfi

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/zeevx-laravel-ovalfi/health.svg)

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

###  Alternatives

[fumeapp/modeltyper

Generate TypeScript interfaces from Laravel Models

196277.9k](/packages/fumeapp-modeltyper)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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