Download the PHP package satlane/satlane-php without Composer

On this page you can find all versions of the php package satlane/satlane-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of satlane/satlane-php

Informations about the package satlane-php

satlane-php

Official PHP SDK for SatLane — non-custodial Bitcoin payments. Vendor keeps the keys, SatLane handles the checkout and payment detection.

Requires PHP 8.1+.

Quickstart

That's the full happy path. The buyer lands on the hosted checkout, pays with any Bitcoin wallet (or Cash App / Strike / Coinbase via the built-in guides), and you get a signed webhook when the payment confirms.

Receiving webhooks

Always verify against the raw request body, not parsed JSON. Body parsers discard the bytes the signature is computed over.

Top-up payments

If the buyer underpays, the invoice transitions to underpaid and the watcher keeps listening. If they send a follow-up transaction, the watcher automatically merges the payments and the invoice transitions to paid (or late_paid / overpaid depending on the new total).

That means your handler can receive multiple invoice.underpaid events for the same invoice before invoice.paid lands. Dedupe by event_id only — never by (invoice_id, event_type).

The hosted checkout surfaces a "Send remaining X sats" CTA with a fresh bitcoin: URI for only the missing amount, so the buyer doesn't double-pay by rescanning the original QR.

Error handling

Full error catalog: satlane.com/docs/errors.

Configuration

Or from env vars:

What the SDK covers

Surface Method
Create an invoice $client->invoices->create([...], idempotencyKey: '...')
List invoices $client->invoices->list([...])
Retrieve $client->invoices->retrieve($id)
Timeline $client->invoices->timeline($id)
Cancel $client->invoices->cancel($id)
Test-mode simulate $client->invoices->simulate($id, ['event' => 'paid'])
Public snapshot (no auth) $client->invoices->publicSnapshot($id)
Webhook endpoints CRUD $client->webhooks->{list, create, update, delete, rotate, test}($storeId, ...)
Delivery history $client->webhooks->deliveries($storeId)
Verify a webhook WebhookSignature::verify($rawBody, $header, $secret)

For endpoints we haven't wrapped yet, drop to the raw HTTP:

Going live checklist

  1. Store has a mainnet xpub registered.
  2. Store's test_mode toggle is off.
  3. SATLANE_API_KEY is the sl_live_... variant.
  4. Webhook URL is HTTPS and reachable from the public internet.
  5. Your handler responds 2xx quickly (<10s timeout), persists the side effect synchronously, and dedupes by event_id.
  6. You verify the signature on every request.
  7. You handle invoice.payment_reverted (rare but real — reverse fulfillment on chain reorgs).

Links

License

MIT.

All versions of satlane-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-json Version *
ext-hash Version *
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package satlane/satlane-php contains the following files

Loading the files please wait ...