PHPackages                             capitual/cappay-php-sdk - 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. capitual/cappay-php-sdk

ActiveLibrary[Payment Processing](/categories/payments)

capitual/cappay-php-sdk
=======================

PHP SDK for CapPay (Capitual Payment Gateway)

1.0.4(6y ago)417MITPHP

Since Jul 29Pushed 6y ago1 watchersCompare

[ Source](https://github.com/Capitual/cappay-php-sdk)[ Packagist](https://packagist.org/packages/capitual/cappay-php-sdk)[ RSS](/packages/capitual-cappay-php-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)DependenciesVersions (5)Used By (0)

CapPay SDK for PHP
==================

[](#cappay-sdk-for-php)

This is CapPay's PHP SDK.

With this SDK you are able to start receiving payments in crypto-currencies in a few minutes!

Logging In
----------

[](#logging-in)

Note that you have to login to the button generator on [CapPay Button Generator](https://cappay.capitual.com/my/button).

You will also need your merchant ID, that can be found [on your Capitual profile](https://my.capitual.com/account).

Installing
----------

[](#installing)

You can either [download the library](http://capgo.gq/phpsdk-dl) or use [Composer](https://getcomposer.org) to install it directly:

```
composer require capitual/cappay-php-sdk
```

After it, include the `CapPay.php` file on your project (or Composer's autoload file) and you are ready to start using CapPay.

Creating a new invoice
----------------------

[](#creating-a-new-invoice)

In order to send a new invoice to receive a new payment, create a new instance of the Capitual\\CapPay class.

```
$invoice = new \Capitual\CapPay;
```

Then set your merchant ID.

```
$invoice->merchant = 1234;
```

Set the address of your Capitual wallet that will receive the funds for this payment. **This is not a crypto-wallet address.** This is the address of one of your Capitual wallets. Note that you may choose a wallet of any currency, but if the currency is different from the invoice currency (that we'll set below), an exchange rate will apply. Otherwise, no fees are involved.

```
$invoice->wallet = 'CAP-XXXXXXXX-XXXXXX-XX';
```

Now it's time to set the payment currency and value. The value is a string. Always use dots (.) for decimals (do not worry about using the correct amount of decimals if this is not relevant for your use case), and not commas.

The currency may be one of the following:

CodeCurrencyBTCBitcoinLTCLitecoinDSHDashUSDUS DollarEUREuroBRLBrazilian Real```
$invoice->currency = 'USD';
$invoice->value = '100.00';
```

Now, set the payee's email address. Note that the invoice will also be sent to his email.

```
$invoice->payee = 'johndoe@mailinator.com';
```

If you want, you can also set a human-readable payment description for your customer:

```
$invoice->description = 'Payment for order 123'; // optional
```

Optionally set expiration date, as a Unix timestamp (UTC timezone).

```
$invoice->expires = strtotime("+48 hours"); // optional
```

**IPN**: If you want, you can set a public accessible URL that Capitual servers should call once the payment is done. You may include query string variables.

```
$invoice->ipn = 'https://mysite.com/ipn.php'; // optional
```

**That's all!** To create the invoice, just do:

```
$invoice->create();
```

After the invoice was created, you may retrieve its ID using:

```
$invoice_id = $invoice->id;
// proceed to save $invoice_id to the database...
```

You may also get its URL using:

```
$url = $invoice->url;

// or a short link
$url = $invoice->getShortLink();
```

You may redirect or create a link to this URL for your user to be able to pay.

It's also advisable to set a return URL, which your user will be redirected to after the payment (it does not work on the shortlink). To do so, just append a "return\_url" query param.

```
$url = $invoice->url.'?return_url=http://yoursite.com/thanks.php';
```

Note that the user requesting your `return_url` **does not mean the payment is complete**, as crypto transactions require waiting for confirmation time. Delivering the product/service before the confirmation is dangerous and may lead to its loss, as transactions with low fees may never be confirmed. Use IPN (see next article) for checking when the transaction is confirmed.

IPN - Instant Payment Notification
----------------------------------

[](#ipn---instant-payment-notification)

The URL you set as `ipn` will receive HTTP POST requests (`x-www-form-urlencoded`) with two variables:

VariableDescriptionInvoiceIDThe invoice ID (as in `$invoice->id`)TypeMessage typeThe message type may be (notice the case):

TypeDescription`Received`The invoice was paid, but not yet confirmed. It's **not** yet safe to deliver the product/service.`Paid`The invoice was paid and confirmed. It's now safe to deliver the product/service.`Cancelled`The invoice was cancelled (this can only be done by the invoice sender)In a perfect situation, IPN by itself could be enough, but unfortunately we know that the bad guys are trying to break things all the time, and may discover your IPN URL and spoof the request, making your system to think a payment has been done while it hasn't. Therefore, **you shall not take IPN requests as a reliable source of truth**. Rather, treat it simply as a notification. You should retrieve information about the invoice when you receive a IPN request.

Retrieving information about an invoice
---------------------------------------

[](#retrieving-information-about-an-invoice)

In order to retrieve information about an invoice, simply create a new instance of the class, passing the invoice ID as argument to the constructor:

```
$invoice = new \Capitual\CapPay('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX');
```

Now, you may get every property of the class, just like you've just set it.

```
echo $invoice->currency; // "USD"
echo $invoice->amount; // "100.00"
```

Note that for security reasons it's not possible to retrieve `$invoice->payee` using this method. You should store it on your database after creating the invoice. You may retrieve the invoice payee by logging in to your [Capitual account](https://my.capitual.com), or by implementing the complete [Capitual API](https://my.capitual.com/apps/mine).

You may get the invoice status using:

```
echo $invoice->status; // "pending", "paid", "canceled" or "expired"
```

For the sake of code readability, the invoice status strings are also available as static values:

```
if ($invoice->status === \Capitual\CapPay::STATUS_PENDING) {
	// no payment has been received yet
}
elseif ($invoice->status === \Capitual\CapPay::STATUS_PAID) {
	// paid and confirmed
}
elseif ($invoice->status === \Capitual\CapPay::STATUS_CANCELED) {
	// invoice cancelled by its sender
}
elseif ($invoice->status === \Capitual\CapPay::STATUS_EXPIRED) {
	// due date has passed without payment
}
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity61

Established project with proven stability

 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

4

Last Release

2476d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7cad19dafdf9bb28fd1bf74a734f4c8d7aabf3abdaa67879ca07126cecf7afc8?d=identicon)[jesobreira](/maintainers/jesobreira)

---

Top Contributors

[![jesobreira](https://avatars.githubusercontent.com/u/3002249?v=4)](https://github.com/jesobreira "jesobreira (12 commits)")

---

Tags

cryptopaymentgatewaybitcoincryptocurrencies

### Embed Badge

![Health badge](/badges/capitual-cappay-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/capitual-cappay-php-sdk/health.svg)](https://phpackages.com/packages/capitual-cappay-php-sdk)
```

###  Alternatives

[coingate/coingate-php

CoinGate library for PHP

56459.2k1](/packages/coingate-coingate-php)[bitpay/sdk

Complete version of the PHP library for the new cryptographically secure BitPay API

42337.5k4](/packages/bitpay-sdk)[omnipay/bitpay

BitPay driver for the Omnipay payment processing library

1383.2k1](/packages/omnipay-bitpay)[opennode/opennode-php

OpenNode PHP library for API v1

1625.3k](/packages/opennode-opennode-php)[coingate/omnipay-coingate

CoinGate driver for the Omnipay payment processing library

1037.0k1](/packages/coingate-omnipay-coingate)[plisio/plisio-api-php

155.8k](/packages/plisio-plisio-api-php)

PHPackages © 2026

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