README

Sipay (CCPayment) driver for the Omnipay PHP payment processing library

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP. This package implements Sipay support for Omnipay.

Installation

composer require tcgunel/omnipay-sipay

Requirements

• PHP >= 8.0
• ext-json
• ext-openssl

Configuration

use Omnipay\Omnipay;

$gateway = Omnipay::create('Sipay');

$gateway->setAppId('your_app_id');           // app_id from provider
$gateway->setAppSecret('your_app_secret');   // app_secret from provider
$gateway->setMerchantKey('your_merchant_key'); // merchant_key from provider
$gateway->setTestMode(true);                 // Use test endpoint

Provider Selection

This package supports multiple CCPayment providers that share the same API protocol. By default, the provider is set to sipay. You can switch to any supported provider:

$gateway->setProvider('paybull');   // Use Paybull endpoints
$gateway->setProvider('qnbpay');   // Use QNBPay endpoints
$gateway->setProvider('halkode');  // Use Halkode endpoints

Supported Providers

The provider name is case-insensitive. All providers use the same API methods (purchase, refund, void, etc.).

Supported Methods

Purchase (Non-3D)

$response = $gateway->purchase([
    'amount'       => '100.00',
    'currency'     => 'TRY',
    'card'         => $cardData,
    'installment'  => 1,
    'transactionId' => 'INV-001',
    'items'        => [
        ['name' => 'Product', 'price' => 100, 'quantity' => 1, 'description' => 'Desc'],
    ],
])->send();

if ($response->isSuccessful()) {
    echo $response->getTransactionId(); // auth_code
}

Purchase (3D Secure)

$response = $gateway->purchase([
    'amount'       => '100.00',
    'currency'     => 'TRY',
    'card'         => $cardData,
    'installment'  => 1,
    'transactionId' => 'INV-001',
    'secure'       => true,
    'returnUrl'    => 'https://example.com/success',
    'cancelUrl'    => 'https://example.com/cancel',
    'clientIp'     => '127.0.0.1',
    'items'        => [
        ['name' => 'Product', 'price' => 100, 'quantity' => 1, 'description' => 'Desc'],
    ],
])->send();

if ($response->isRedirect()) {
    echo $response->getRedirectHtml(); // Render this HTML
}

Complete Purchase (3D Callback)

$response = $gateway->completePurchase()->send();

if ($response->isSuccessful()) {
    echo $response->getTransactionId();
}

Void (Cancel)

$response = $gateway->void([
    'transactionId' => 'INV-001',
    'currency'      => 'TRY',
])->send();

if ($response->isSuccessful()) {
    echo 'Transaction cancelled.';
}

Refund

$response = $gateway->refund([
    'transactionId' => 'INV-001',
    'amount'        => '50.00',
    'currency'      => 'TRY',
])->send();

if ($response->isSuccessful()) {
    echo 'Refund successful.';
}

BIN Lookup (Installment Query)

$response = $gateway->binLookup([
    'card'     => ['number' => '979203XXXXXXXXXX'],
    'amount'   => '100.00',
    'currency' => 'TRY',
])->send();

if ($response->isSuccessful()) {
    $data = $response->getData();
    // $data['data'] contains POS and installment info
}

Installment Rates (All Commissions)

$response = $gateway->installmentRates([
    'currency' => 'TRY',
])->send();

if ($response->isSuccessful()) {
    $data = $response->getData();
    // $data['data'] contains all commission rates
}

Endpoints

Endpoints are automatically resolved based on the selected provider and test mode. See the Provider Selection section above for the full list of endpoints.

Authentication

The gateway uses token-based authentication. A Bearer token is automatically obtained before each API request using your app_id and app_secret.

Hash Key

For purchase, refund, and void operations, a hash key is generated using AES-256-CBC encryption with the following data:

data = total|installment|currencyCode|merchantKey|invoiceId

The hash key is automatically generated and validated by the library.

Running Tests

vendor/bin/phpunit

License

MIT