PHPackages                             incraigulous/php-profitstars - 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. [API Development](/categories/api)
4. /
5. incraigulous/php-profitstars

ActiveLibrary[API Development](/categories/api)

incraigulous/php-profitstars
============================

A service that processes ACH transactions throgh Jack Henry's ProfitStars API

2.1(9y ago)2211MITPHPPHP &gt;=5.3.0

Since Nov 4Pushed 9y ago2 watchersCompare

[ Source](https://github.com/incraigulous/php-profitstars)[ Packagist](https://packagist.org/packages/incraigulous/php-profitstars)[ Docs](https://github.com/incraigulous/php-profitstars)[ RSS](/packages/incraigulous-php-profitstars/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (2)DependenciesVersions (9)Used By (0)

php-profitstars
===============

[](#php-profitstars)

[![Latest Version on Packagist](https://camo.githubusercontent.com/5de8607246697e9e8702ec2f94bafe5a8a1020bfc444836c9864bd3c94b1d62c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f696e6372616967756c6f75732f7068702d70726f66697473746172732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/incraigulous/php-profitstars)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/dda018ca91262da9a9e8dd1f89a526445d68c316f2752023b3323da53f3ee5e8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f696e6372616967756c6f75732f7068702d70726f66697473746172732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/incraigulous/php-profitstars)

Jack Henry ProfitStars provides an API for handling ACH transactions. This package is a wrapper to access these transactions.

The package is currently not exhaustive in terms of what is available from the API; I have only implemented parts of the API that are needed for my use. That said, expanding this package should be fairly trivial and if you should need additional pieces please feel free to modify and submit a pull request.

Install
-------

[](#install)

Via Composer

```
$ composer require incraigulous/php-profitstars
```

Usage
-----

[](#usage)

```
$credentials = [
    'store-id'=>"YOUR_STORE_ID",
    'store-key'=>"YOUR_STORE_KEY",
    'entity-id'=>"YOUR_ENTITY_ID",
    'location-id'=>"YOUR_LOCATION_ID",
];
$proc = new \jdavidbakr\ProfitStars\ProcessTransaction($credentials);

// Test connection
if($proc->TestConnection()) {
	// Success
}

// Test credentials
if($proc->TestCredentials()) {
	// Success
}
```

Usage - Processing Transactions
-------------------------------

[](#usage---processing-transactions)

```
$credentials = [
    'store-id'=>"YOUR_STORE_ID",
    'store-key'=>"YOUR_STORE_KEY",
    'entity-id'=>"YOUR_ENTITY_ID",
    'location-id'=>"YOUR_LOCATION_ID",
];
$proc = new \jdavidbakr\ProfitStars\ProcessTransaction($credentials);
$trans = new \jdavidbakr\ProfitStars\WSTransaction;

// AuthorizeTransaction
$trans->RoutingNumber = 111000025;
$trans->AccountNumber = 5637492437;
$trans->TotalAmount = 9.95;
$trans->TransactionNumber = 12334;
$trans->NameOnAccount = 'Joe Smith';
$trans->EffectiveDate = '2015-11-04';
if($proc->AuthorizeTransaction($tras)) {
	// ReferenceNumber in $proc->ReferenceNumber
} else {
	// Error message in $proc->ResponseMessage
}

// CaptureTransaction
$proc->ReferenceNumber = 'reference number';
if($proc->CaptureTransaction(9.95)) {
	// Success
} else {
	// Error message in $proc->ResponseMessage
}

// VoidTransaction
$proc->ReferenceNumber = 'reference number';
if($proc->VoidTransaction()) {
	// Success;
} else {
	// Error message in $proc->ResponseMessage
}

// RefundTransaction
$proc->ReferenceNumber = 'reference number';
if($proc->RefundTransaction()) {
	// Success, refund info in $proc->ResponseMessage
} else {
	// Error message in $proc->ResponseMessage
}
```

Usage - Recurring Payments
--------------------------

[](#usage---recurring-payments)

```
$credentials = [
    'store-id'=>"YOUR_STORE_ID",
    'store-key'=>"YOUR_STORE_KEY",
    'entity-id'=>"YOUR_ENTITY_ID",
    'location-id'=>"YOUR_LOCATION_ID",
];
$proc = new \jdavidbakr\ProfitStars\PaymentVault($credentials);
$recur = new \jdavidbakr\ProfitStars\WSRecurr;
$cust = new \jdavidbakr\ProfitStars\WSCustomer;
$account = new \jdavidbakr\ProfitStars\WSAccount;

// RegisterCustomer
$cust->IsCompany = false;
$cust->CustomerNumber = 12345;
$cust->FirstName = 'Alex';
$cust->LastName = 'Ramirez';
$cust->Email = 'test@example.com';
$cust->Address1 = '1234 N Sunny Ln';
$cust->City = 'Tulsa';
$cust->StateRegion = 'OK';
$cust->PostalCode = '12345';
if($proc->RegisterCustomer($cust)) {
	// Success;
} else {
	// Error message in $proc->ResponseMessage
}

// RegisterAccount
$account->CustomerNumber = 12345; // Should match the RegisterCustomer value
$account->NameOnAccount = 'Joe Smith';
$account->RoutingNumber = 111000025;
$account->AccountNumber = 5637492437;
$account->AccountReferenceID = 67890; // This must be unique and will be used to setup the recurring payment
if($proc->RegisterAccount($account)) {
	// Success
} else {
	// Error message in $proc->ResponseMessage
}

// SetupRecurringPayment
$recur->CustomerNumber = 12345; // What you used in RegisterCustomer
$recur->AccountReferenceID = 67890; // What you used in RegisterAccount
$recur->Amount = 1.23; // The amount that will be charged each time
$recur->InvoiceNumber = 09876; // Optional
$recur->Frequency = 'Once_a_Month'; // Once_a_Month, Twice_a_Month, Once_a_Week, Every_2_Weeks, Once_a_Quarter, Twice_a_Year, Once_a_Year
$recur->PaymentDay = 1; // See notes below
$recur->NumPayments = 10; // Valid values are 1 - 100, or 999 for indefinite
$recur->PaymentsToDate = 0; // Should be zero
$recur->NextPaymentDate = '2015-11-04'; // Must not be before tomorrow
$recur->RecurringReferenceID = 12345; // Must set a value here like you did in the customer and account calls
if($proc->SetupRecurringPayment($recur)) {
	// Success
} else {
	// Error message is $proc->ResponseMessage
}
```

### Recurring Notes

[](#recurring-notes)

For recurring, a Customer Number and Account Reference ID is required.

The Frequency and the PaymentDay define the schedule of the recurring payment. Payment Day is defined as follows:

- Once\_a\_Month: 1 - 31, or 32 for the last day of the month
- Once\_a\_Quarter: Same as above
- Twice\_a\_year: Same as above
- Once\_a\_Year: Same as above
- Twice\_a\_Month: 1 = 1st and 15th, 2 = 15th and last
- Once\_a\_Week: 0 - Sun, 1 = Mon, ... 5 = Fri, 6 = Sat
- Every\_2\_Weeks: same as Once\_a\_Week

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

Testing
-------

[](#testing)

PhpUnit can be run directly from the package folder. You will need to include a .env file to provide your sandbox connection credentials. An example .env file has been provided (.env.example).

Security
--------

[](#security)

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

Credits
-------

[](#credits)

This package was forked from @jdavidbakers's Laravel specific Profit Stars SDK.

- [J David Baker](https://github.com/jdavidbakr)
- [Incraigulous](https://github.com/incraigulous)
- [All Contributors](../../contributors)

License
-------

[](#license)

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

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 52% 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 ~33 days

Recently: every ~57 days

Total

8

Last Release

3613d ago

Major Versions

1.0.5 → 2.02016-06-17

### Community

Maintainers

![](https://www.gravatar.com/avatar/8881ef19db4ab59a70646ca205921b6e68badc9d5fdb6dfbb9b2b33db30af2ad?d=identicon)[incraigulous](/maintainers/incraigulous)

---

Top Contributors

[![incraigulous](https://avatars.githubusercontent.com/u/5910297?v=4)](https://github.com/incraigulous "incraigulous (13 commits)")[![jdavidbakr](https://avatars.githubusercontent.com/u/25177?v=4)](https://github.com/jdavidbakr "jdavidbakr (12 commits)")

---

Tags

achProfitStars

### Embed Badge

![Health badge](/badges/incraigulous-php-profitstars/health.svg)

```
[![Health](https://phpackages.com/badges/incraigulous-php-profitstars/health.svg)](https://phpackages.com/packages/incraigulous-php-profitstars)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)

PHPackages © 2026

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