Download the PHP package stackapi/stackapi-php without Composer
On this page you can find all versions of the php package stackapi/stackapi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stackapi/stackapi-php
More information about stackapi/stackapi-php
Files in stackapi/stackapi-php
Package stackapi-php
Short Description Official PHP SDK for StackApi: payments, payouts, messaging, identity, bills, virtual cards, logistics and more behind one key.
License MIT
Homepage https://stackapi.app
Informations about the package stackapi-php
StackApi PHP SDK
The official PHP library for StackApi: payments, payouts, SMS and email, identity checks, bill payments, virtual cards, logistics, FX rates and more behind one key.
- PHP 8.1 or later with the
curlandjsonextensions. No other dependencies. - Test keys (
Psk-test-...) run everything in the sandbox: nothing is sent, booked or charged. Switch to a live key with the same code.
Install
First request
Every method sends the array you give it and returns the API's JSON answer as an array. The fields are the ones in the API reference.
| Resource | Methods |
|---|---|
notifications |
sendSms, sendBulkSms, smsStatus, sendOtp, verifyOtp, sendEmail, createEmailDomain, listEmailDomains, getEmailDomain, verifyEmailDomain, setEmailDomainReceiving, removeEmailDomain, simulateInbound, listInbound, getInbound |
payments |
initiate, get |
identity |
verifyBvn, verifyNin, verifyPhone, verifyCac, verifyBankAccount, companySearch, verify($check, $body), pricing |
addressVerifications |
create, list, get, simulateComplete |
vtu |
airtime, data, plans, electricity, cableTv, betting, education, verifyCustomer, transaction |
payouts |
banks, fees, resolve, create, get, list |
banking |
createAccount, listAccounts, getAccount, payments, simulatePayment, banks, resolve |
fx |
rates, convert, history, currencies |
cards |
createCardholder, listCardholders, getCardholder, create, list, get, fund, withdraw, freeze, unfreeze, terminate, transactions, reveal, simulateTransaction |
logistics |
createAddress, listAddresses, getAddress, categories, createQuote, createShipment, listShipments, getShipment, cancelShipment, simulateShipment |
Anything else your key can call: $stackapi->request('POST', '/v1/commerce/invoices', null, [...]).
Errors
A non-2xx answer throws StackApi\StackApiException with $e->status, $e->errorCode (StackApi's error code, for
example INSUFFICIENT_BALANCE) and $e->getMessage(). A request that never reached StackApi throws with status 0 and
code NETWORK_ERROR.
Reads (GET) are retried on network errors, 429 and 502/503/504. Writes are never retried by the SDK: send your own
reference where the endpoint takes one and repeat the call; the API answers the first result again.
Webhooks
Webhook::verify checks X-StackApi-Signature (v1= HMAC-SHA256 of "<timestamp>.<raw body>") with hash_equals
and refuses a timestamp more than 5 minutes away.
Options
new StackApi($secretKey, $publicKey, ['base_url' => ..., 'timeout' => 30, 'max_retries' => 2])
Tests
composer test (no framework needed).
License
MIT
All versions of stackapi-php with dependencies
ext-curl Version *
ext-json Version *