README

Vakif Katilim sanal pos gateway for the Omnipay PHP payment processing library.

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

Installation

composer require tcgunel/omnipay-vakifkatilim

Usage

Gateway Parameters

Non-3D Purchase

use Omnipay\Omnipay;

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

$gateway->setMerchantId('YOUR_MERCHANT_ID');
$gateway->setCustomerId('YOUR_CUSTOMER_ID');
$gateway->setUserName('YOUR_USERNAME');
$gateway->setPassword('YOUR_PASSWORD');

$response = $gateway->purchase([
    'secure'        => false,
    'amount'        => '12.34',
    'currency'      => 'TRY',
    'transactionId' => 'ORDER-001',
    'installment'   => 0,
    'card'          => [
        'firstName'   => 'John',
        'lastName'    => 'Doe',
        'number'      => '4111111111111111',
        'expiryMonth' => '12',
        'expiryYear'  => '2030',
        'cvv'         => '123',
    ],
])->send();

if ($response->isSuccessful()) {
    echo "Payment successful! Code: " . $response->getCode();
} else {
    echo "Payment failed: " . $response->getMessage();
}

3D Secure Purchase

Step 1: Redirect to bank

$response = $gateway->purchase([
    'secure'        => true,
    'amount'        => '12.34',
    'currency'      => 'TRY',
    'transactionId' => 'ORDER-001',
    'installment'   => 0,
    'returnUrl'     => 'https://yoursite.com/payment/success',
    'cancelUrl'     => 'https://yoursite.com/payment/failure',
    'card'          => [
        'firstName'   => 'John',
        'lastName'    => 'Doe',
        'number'      => '4111111111111111',
        'expiryMonth' => '12',
        'expiryYear'  => '2030',
        'cvv'         => '123',
    ],
])->send();

if ($response->isRedirect()) {
    $response->redirect(); // Redirects to bank 3D page
}

Step 2: Complete purchase (on callback)

$response = $gateway->completePurchase([
    'merchantId'       => 'YOUR_MERCHANT_ID',
    'customerId'       => 'YOUR_CUSTOMER_ID',
    'userName'         => 'YOUR_USERNAME',
    'password'         => 'YOUR_PASSWORD',
    'responseCode'     => $_POST['ResponseCode'],
    'responseMessage'  => $_POST['ResponseMessage'],
    'merchantOrderId'  => $_POST['MerchantOrderId'],
    'md'               => $_POST['MD'],
    'amount'           => '12.34',
    'currency'         => 'TRY',
    'installment'      => 0,
])->send();

if ($response->isSuccessful()) {
    echo "3D Payment successful!";
} else {
    echo "3D Payment failed: " . $response->getMessage();
}

Supported Methods

Currency Codes

Amount Format

Amounts are passed as standard decimal values (e.g., 12.34). The gateway internally converts them to integer format required by VakifKatilim (e.g., 1234).

Hash Algorithm

• Non-3D: SHA1Base64(MerchantId + MerchantOrderId + Amount + UserName + SHA1Base64(Password))
• 3D: SHA1Base64(MerchantId + MerchantOrderId + Amount + OkUrl + FailUrl + UserName + SHA1Base64(Password))

Endpoints

Note: Test URLs are not available for VakifKatilim. Only production endpoints are provided.

Not Implemented

Cancel and Refund operations are not implemented. The CP.VPOS reference returns error messages for these operations, indicating they are not supported by this bank.

Testing

composer test

License

MIT License. See LICENSE for details.