payfast/payfast-php-sdk

Payfast PHP Library

v1.1.6 2024-02-28 09:54 UTC

Requires

• php: >=8.1
• ext-json: *
• guzzlehttp/guzzle: >=6.0.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.8

MIT

• Payfast

• php
• api
• payfast
• onsite

README

The Payfast PHP SDK provides an easy-to-use library for integrating Payfast payments into your project. This includes Custom Integration, Onsite Integration and all APIs.

Requirements

PHP 8.1 and later.

Documentation

See the Developer Docs

Composer

You can install the library via Composer. Run the following command:

composer require payfast/payfast-php-sdk

To use the library, use Composer's autoload:

require_once('vendor/autoload.php');

Getting Started

Custom Integration

Build a checkout form and receive payments securely from the Payfast payment platform.

NB! The default value of 'testMode' is true.

See the Developer Docs

try {
    $payfast = new PayFastPayment(
        [
            'merchantId' => '10000100',
            'merchantKey' => '46f0cd694581a',
            'passPhrase' => 'jt7NOE43FZPn',
            'testMode' => true
        ]
    );

    $data = [
        'amount' => '100.00',
        'item_name' => 'Order#123'
    ];

    echo $payfast->custom->createFormFields($data, ['value' => 'PAY NOW', 'class' => 'btn']);
} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

Onsite Payments

Integrate Payfast’s secure payment engine directly into your checkout page.

NB! The default value of 'testMode' is false. Otherwise we get the Exception: " There was an exception: Sorry but Onsite is not available in Sandbox mode"

See the Developer Docs

// Include: <script src="https://www.payfast.co.za/onsite/engine.js"></script>

try {
    $payfast = new PayFastPayment(
        [
            'merchantId' => '10000100',
            'merchantKey' => '46f0cd694581a',
            'passPhrase' => 'jt7NOE43FZPn',
            'testMode' => false
        ]
    );

    $data = [
        'amount' => '100.00',
        'item_name' => 'Order#123'
    ];

    // Generate payment identifier
    $identifier = $payfast->onsite->generatePaymentIdentifier($data);

    if($identifier!== null){
        echo '<script type="text/javascript">window.payfast_do_onsite_payment({"uuid":"'.$identifier.'"});</script>';
    }
} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

API

Recurring Billing

The Subscription Payments API gives Merchants the ability to interact with subscriptions on their accounts.

NB! The default value of 'testMode' is true.

See the Developer Docs

try {
    $api = new PayFastApi(
        [
            'merchantId' => '10018867',
            'passPhrase' => '2uU_k5q_vRS_',
            'testMode' => true
        ]
    );

    $fetchArray = $api->subscriptions->fetch('2afa4575-5628-051a-d0ed-4e071b56a7b0');

    $pauseArray = $api->subscriptions->pause('2afa4575-5628-051a-d0ed-4e071b56a7b0', ['cycles' => 1]);

    $unpauseArray = $api->subscriptions->unpause('2afa4575-5628-051a-d0ed-4e071b56a7b0');

    $cancelArray = $api->subscriptions->cancel('2afa4575-5628-051a-d0ed-4e071b56a7b0');

    $updateArray = $api->subscriptions->update('2afa4575-5628-051a-d0ed-4e071b56a7b0', ['cycles' => 1]);

    $adhocArray = $api->subscriptions->adhoc('290ac9a6-25f1-cce4-5801-67a644068818', ['amount' => 500, 'item_name' => 'Test adhoc']);

} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

Update card

The update card endpoint allows you to provide buyers with a link to update their card details on a Recurring Billing subscription or Tokenization charges.

NB! The default value of 'testMode' is false. Otherwise we get the Exception: " There was an exception: Sorry but Onsite is not available in Sandbox mode"

See the Developer Docs

try {
    $payfast = new PayFastPayment(
            [
                'merchantId' => '10000100',
                'merchantKey' => '46f0cd694581a',
                'passPhrase' => 'jt7NOE43FZPn',
                'testMode' => false
            ]
        );

    echo $payfast->custom->createCardUpdateLink('2afa4575-5628-051a-d0ed-4e071b56a7b0', 'https://www.example.com/return', 'Update your card', ['target' => '_blank']);

} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

Transaction History

The transaction history API gives Merchants the ability to interact with their Payfast account.

NB! The default value of 'testMode' is true.

See the Developer Docs

try {
    $api = new PayFastApi(
        [
            'merchantId' => '10018867',
            'passPhrase' => '2uU_k5q_vRS_',
            'testMode' => true
        ]
    );

    $rangeArray = $api->transactionHistory->range(['from' => '2020-08-01', 'to' => '2020-08-07', 'offset' => 0, 'limit' => 1000]);

    $dailyArray = $api->transactionHistory->daily(['date' => '2020-08-07', 'offset' => 0, 'limit' => 1000]);

    $weeklyArray = $api->transactionHistory->weekly(['date' => '2020-08-07', 'offset' => 0, 'limit' => 1000]);

    $monthlyArray = $api->transactionHistory->monthly(['date' => '2020-08', 'offset' => 0, 'limit' => 1000]);

} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

Credit card transaction query

The credit card transaction query API gives Merchants the ability to query credit card transactions.

NB! The default value of 'testMode' is true.

See the Developer Docs

try {
    $api = new PayFastApi(
        [
            'merchantId' => '10018867',
            'passPhrase' => '2uU_k5q_vRS_',
            'testMode' => true
        ]
    );

    $creditCardArray = $api->creditCardTransactions->fetch('1124148');

} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}

Refunds

The Refunds API Providing gives Merchants the ability to perform refunds on their account.

NB! The default value of 'testMode' is false. Otherwise we get the Exception: " There was an exception: Sorry but Onsite is not available in Sandbox mode"

See the Developer Docs

try {
    $api = new PayFastApi(
        [
            'merchantId' => '10018867',
            'passPhrase' => '2uU_k5q_vRS_',
            'testMode' => false
        ]
    );

    $refundFetchArray = $api->refunds->fetch('dc0521d3-55fe-269b-fa00-b647310d760f');

    $refundCreateArray = $api->refunds->create('dc0521d3-55fe-269b-fa00-b647310d760f', ['amount' => 50, 'reason' => 'Product returned', 'acc_type' => 'savings']);

} catch(Exception $e) {
    echo 'There was an exception: '.$e->getMessage();
}