Paystack

Paystack PHP SDK Documentation

Welcome

This documentation provides a comprehensive guide to the MusheAbdulHakim\Paystack PHP SDK, a robust and intuitive library designed for seamless integration with the Paystack API. Built with a focus on developer experience, this SDK offers a fluent, object-oriented interface to manage your payments, customers, subscriptions, and more.

Key Features:

• Fluent API: Chain method calls for clean, readable, and highly maintainable code.
• Object-Oriented Design: Encapsulates Paystack API endpoints into dedicated classes for logical organization.
• PSR-18 HTTP Client Support: Flexible integration with any PSR-18 compatible HTTP client.
• Strong Typing: Leverages PHP’s type hints for improved code quality and IDE support.
• Extensible Architecture: Easily extendable to accommodate custom transporters or new API modules.

Getting Started

Installation

The recommended way to install the Paystack PHP SDK is via Composer:

composer require musheabdulhakim/paystack

Quick Start

Initialize the Paystack client using your secret key to begin interacting with the API.

Simple Initialization:

<?php

use MusheAbdulHakim\Paystack\Paystack;

$secretKey = 'sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxx'; // Replace with your actual Paystack secret key

$client = Paystack::client($secretKey);

// Example: List all transactions
$transactions = $client->transaction()->list();
print_r($transactions);

?>

Advanced Initialization with Factory:

For more control over the HTTP client, base URI, or default headers, use the Paystack::factory() method:

<?php

use MusheAbdulHakim\Paystack\Paystack;
use GuzzleHttp\Client as GuzzleHttpClient; // Example: Using Guzzle as a custom client

$secretKey = 'sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxx'; // Replace with your actual Paystack secret key

$client = Paystack::factory()
    ->withSecretKey($secretKey)
    ->withBaseUri('[https://api.paystack.com/](https://api.paystack.com/)') // Optional: Specify a custom base URI
    ->withHeaders([ // Optional: Add custom headers
        'X-App-Version' => '1.0',
        'User-Agent' => 'MyCustomPaystackApp/1.0',
    ])
    ->withHttpClient(new GuzzleHttpClient()) // Optional: Provide a custom PSR-18 HTTP client
    ->make();

// Example: Create a new customer
$customer = $client->customer()->create([
    'email' => 'new.customer@example.com',
    'first_name' => 'New',
    'last_name' => 'Customer',
]);
print_r($customer);

?>

API Reference

Explore the dedicated classes for each Paystack API resource:

• Apple Pay
  • Manage Apple Pay domains (register, list, unregister).
• Bulk Charges
  • Initiate, list, fetch, pause, and resume bulk charge operations.
• Charges
  • Directly charge customers, submit authentication details (PIN, OTP, Phone, Birthday, Address), and check pending charge status.
• Customers
  • Create, list, fetch, update, validate customer details, and manage risk actions (blacklist/whitelist).
• Disputes
  • List, fetch, update, resolve disputes, and upload/manage evidence.
• Integration
  • Fetch and update payment session timeout settings.
• Miscellaneous
  • Retrieve lists of banks, countries, and states.
• Payment Pages
  • Create, list, fetch, update payment pages, check slug availability, and add products to pages.
• Payment Requests
  • Create, list, fetch, verify, notify, finalize, update, and archive payment requests (invoices), and get totals.
• Plans
  • Create, list, fetch, and update subscription plans.
• Products
  • Create, list, fetch, and update products.
• Refunds
  • Create, list, and fetch details of refunds for transactions.
• Settlements
  • List settlements and retrieve transactions associated with specific settlements.
• Subaccounts
  • Create, list, fetch, and update subaccounts for splitting payments.
• Subscriptions
  • Create, list, fetch, enable, disable subscriptions, and generate/send management links.
• Terminals
  • Send events to terminals, check event status, get terminal presence, list, fetch, update, commission, and decommission devices.
• Transactions
  • Initialize, verify, list, fetch transactions, charge authorizations, view timelines, get totals, export data, and perform partial debits.
• Transaction Splits
  • Create, list, fetch, update transaction splits, and manage subaccounts within a split.
• Transfers
  • Initiate single and bulk transfers, finalize transfers with OTP, list, fetch, and verify transfer status.
• Transfer Control
  • Retrieve account balance and ledger, and manage OTP settings for transfers.
• Transfer Recipients
  • Create single and bulk transfer recipients, list, fetch, update, and delete recipients.
• Verifications
  • Resolve bank accounts, validate bank accounts, and resolve card BINs.
• Virtual Accounts
  • Create, assign, list, fetch, requery, deactivate virtual accounts, manage split transactions, and retrieve bank providers.

Extending the SDK

The MusheAbdulHakim\Paystack SDK is designed for extensibility. You can customize its behavior by providing your own PSR-18 HTTP client, or by implementing custom transporters to handle request/response logic. This allows for advanced use cases such as custom logging, error handling, or integrating with specific HTTP client libraries.

License

This Paystack PHP SDK is open-sourced software licensed under the MIT license.