README

Introduction

The PaymentSDK for PHP facilitates the integration of Payment SDK's payment and checkout features into your PHP applications. This comprehensive guide will assist you in the setup and utilization of the PaymentSDK.

Prerequisites

Before getting started, ensure you have the following:

PHP installed on your server or development environment.
Payment SDK API credentials, including the IV Key, Consumer Secret, Consumer Key.

Installation

Download the Payment SDK: Download the Payment SDK and include it in your project.
```
# Example using Composer
composer require paymentsdk/payment-sdk
```
Include the Composer autoloader in your PHP file:
```
require_once 'vendor/autoload.php';
```

Instantiate the PaymentSDK class with your credentials:

use PaymentSDK\PaymentSDK\PaymentSDK;

// Replace these values with your actual credentials
$IVKey = 'your_iv_key';
$consumerSecret = 'your_consumer_secret';
$environment = 'sandbox';
$rootDomain = 'example.com'

Checkout Usage

To initialize the PaymentSDK class, provide the $IVKey, $consumerKey, $consumerSecret, $rootDomain, and $environment parameters. The $environment should be one of the following: 'production' or 'sandbox'.
```
$PaymentSDK = new PaymentSDK($IVKey, $consumerKey, $consumerSecret, $rootDomain, $environment);
```

Validate Payload

try {
$PaymentSDK->validateCheckoutPayload($payload);
} catch (Exception $error) {
echo 'Error: ' . $error->getMessage() . "\n";
}

Encrypt Payload

$encryptedPayload = $PaymentSDK->encrypt($payload);

Get Checkout Status

try {
$PaymentSDK->getCheckoutStatus($payload["merchant_transaction_id"]);
} catch (Exception $error) {
echo 'Error: ' . $error->getMessage() . "\n";
}

Build Checkout URL

try {
    $checkoutUrl =
    'https://sandbox.checkout.{{rootDomain}}/?access_key=' .
    urlencode($accessKey) .
    '&payload=' .
    urlencode($encryptedPayload);
     echo 'Checkout URL: ' . $checkoutUrl . "\n";
   } catch (Exception $error) {
     echo 'Error: ' . $error->getMessage() . "\n";
   }

Direct API Usage

To initialize the PaymentSDK class, provide the $IVKey, $consumerSecret, $rootDomain, and $environment parameters. The $environment should be one of the following: 'production' or 'sandbox'.
```
$PaymentSDK = new PaymentSDK($IVKey, $consumerSecret, $rootDomain, $environment);
```

Direct Charge

try {
$PaymentSDK->DirectCharge($payload);
} catch (Exception $error) {
 echo 'Error: ' . $error->getMessage() . "\n";
}

Get Charge Request Status

try {
$PaymentSDK->getChargeRequestStatus($chargeRequestId);
} catch (Exception $error) {
echo 'Error: ' . $error->getMessage() . PHP_EOL;
}

paymentsdk / payment-sdk

Maintainers

Details