Skip to content

KuveytTurk/ktpay-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
samples
samples
 
 
src
src
 
 
tests
tests
 
 
KTPayAutoloader.php
KTPayAutoloader.php
 
 
LICENSE
LICENSE
 
 
README-EN.md
README-EN.md
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 

Repository files navigation

ktpay-php

Minimum PHP Version GitHub Release GitHub License

Bu proje, Kuveyt Türk Katılım Bankası Sanal POS servisleri için geliştirilen entegrasyon alt yapı kodlarını içermektedir. Proje içerisinde yer alan kodlar, Kuveyt Türk Katılım Bankası tarafından sunulan çevrimiçi ödeme hizmetlerini entegre etmek ve sanal pos işlemlerini gerçekleştirmek amacıyla kullanılabilir. Aksi kullanımlar banka tarafından tespit edilip cezai yaptırımlar uygulanmaktadır.

Entegrasyon sırasında karşılaşılan hataların çözümü için Kuveyt Türk Sanal POS Destek ekibi ile iletişime geçebilirsiniz.

English

Gereksinimler

  • PHP >= 5.6.0
  • Composer (KTPayAutoloader kullanılması durumunda zorunlu değil. Ancak PHP konfigurasyonlarında cURL ve JSON eklentileri aktifleştirilmelidir.)

Kurulum

# Proje dosyalarını yerel bilgisayarınıza klonlayın.
git clone https://github.com/kuveytturk/ktpay-php.git

# Entegrasyon bilgilerinizi düzenleyin.
nano .\src\Config.php

# Bağımlıkları yükleyin ve projeyi ayağa kaldırın.
composer install

Composer kullanılmaması durumunda, KTPayAutoloader projeye dahil edilmelidir. KTPayAutoloader sınıfı çağrılırken parametre olarak kütüphanenin yer aldığı dizin işaret edilmelidir.

require_once '../KTPayAutoloader.php';
$base_dir = __DIR__ . '/src'; // Kütüphanenin yer aldığı dizin
$loader = new KTPayAutoloader($base_dir);

Örnek Kodlar

Satış

Request

$paymentRequest = new \KTPay\Models\Request\PaymentRequest();
$paymentRequest->setPaymentType(1);
$paymentRequest->setLanguage(KTPay\Models\Language::TR);
$paymentRequest->setMerchantOrderId('KTPay-PHP-' . mt_rand());
$paymentRequest->setSuccessUrl('https://' . $_SERVER['SERVER_NAME'] . '/samples/success.php');
$paymentRequest->setFailUrl('https://' . $_SERVER['SERVER_NAME'] . '/samples/fail.php');
$paymentRequest->setMerchantId($envConfig['merchantId']);
$paymentRequest->setCustomerId($envConfig['customerId']);
$paymentRequest->setUsername($envConfig['username']);
$paymentRequest->setAmount('100');
$paymentRequest->setCurrency(KTPay\Models\Currency::TL);
$paymentRequest->setInstallmentCount(1);
    $customer = new \KTPay\Models\Customer();
    $customer->setFullName('JOHN DOE');
    $customer->setIdentityNumber('12345678901');
    $customer->setEmail('noreply@kuveytturk.com.tr');
        $phone = new \KTPay\Models\Phone();
        $phone->setCc('90');
        $phone->setSubscriber('5001112233');
    $customer->setPhoneNumber($phone);
    $customer->setIpAddress((new KTPay\Helpers\KTPayHelper)->getClientIP());
$paymentRequest->setCustomer($customer);
    $card = new \KTPay\Models\Card();
    $card->setCardHolderName($cardConfig['cardHolderName']);
    $card->setCardNumber($cardConfig['cardNumber']);
    $card->setExpireMonth($cardConfig['expireMonth']);
    $card->setExpireYear($cardConfig['expireYear']);
    $card->setSecurityCode($cardConfig['securityCode']);
$paymentRequest->setCard($card);
    $cartItem1 = new \KTPay\Models\CartItem();
    $cartItem1->setCartItemName('Product PHYSICAL');
    $cartItem1->setCartItemUrl('https://www.kuveytturk.com.tr');
    $cartItem1->setCartItemType(KTPay\Models\CartItemType::PHYSICAL);
    $cartItem1->setQuantity(1.5);
    $cartItem1->setPrice('10');
    $cartItem1->setTotalAmount('15');
    $cartItem2 = new \KTPay\Models\CartItem();
    $cartItem2->setCartItemName('Product VIRTUAL');
    $cartItem2->setCartItemUrl('https://www.kuveytturk.com.tr');
    $cartItem2->setCartItemType(KTPay\Models\CartItemType::VIRTUAL);
    $cartItem2->setQuantity(1);
    $cartItem2->setPrice('85');
    $cartItem2->setTotalAmount('85');
$paymentRequest->setCart([$cartItem1, $cartItem2]);
    $invoiceAddress = new \KTPay\Models\InvoiceAddress();
    $invoiceAddress->setCompany('XXX LTD.STI.');
    $invoiceAddress->setTaxNumber('111111111');
    $invoiceAddress->setTaxOffice('XXXXXXXXX');
    $invoiceAddress->setAddress('ADDRESS');
    $invoiceAddress->setCity('IZMIT');
    $invoiceAddress->setState(KTPay\Models\State::Kocaeli);
    $invoiceAddress->setCountry(KTPay\Models\Country::TURKIYE);
    $invoiceAddress->setZipCode('123456');
$paymentRequest->setInvoiceAddress($invoiceAddress);
    $shippingAddress = new \KTPay\Models\ShippingAddress();
    $shippingAddress->setFullName('JOHN DOE');
    $shippingAddress->setAddress('ADDRESS');
    $shippingAddress->setCity('IZMIT');
    $shippingAddress->setState(KTPay\Models\State::Kocaeli);
    $shippingAddress->setCountry(KTPay\Models\Country::TURKIYE);
    $shippingAddress->setZipCode('123456');
    $paymentRequest->setShippingAddress($shippingAddress);
$paymentRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "OrderId": 203418187,
    "MerchantOrderId": "KTPay-PHP-1577368010",
    "MD": "OGoIEuSrswsJg3QnyNfpuClWcw0ji2SjbuVu+UptHnQy8wz6GERZrhtvaE6I3+F1"
  },
  "Success": true,
  "ResponseCode": "00",
  "ResponseMessage": "Kart doğrulandı.",
  "BusinessKey": 202406069999000000010245159,
  "TransactionTime": 1717685585
}

Taksitli Satış

Request

$paymentRequest = new \KTPay\Models\Request\PaymentRequest();
$paymentRequest->setPaymentType(1);
$paymentRequest->setLanguage(KTPay\Models\Language::TR);
$paymentRequest->setMerchantOrderId('KTPay-PHP-' . mt_rand());
$paymentRequest->setSuccessUrl('https://' . $_SERVER['SERVER_NAME'] . '/samples/success.php');
$paymentRequest->setFailUrl('https://' . $_SERVER['SERVER_NAME'] . '/samples/fail.php');
$paymentRequest->setMerchantId($envConfig['merchantId']);
$paymentRequest->setCustomerId($envConfig['customerId']);
$paymentRequest->setUsername($envConfig['username']);
$paymentRequest->setAmount('100');
$paymentRequest->setCurrency(KTPay\Models\Currency::TL);
$paymentRequest->setInstallmentCount(2);
    $customer = new \KTPay\Models\Customer();
    $customer->setFullName('JOHN DOE');
    $customer->setIdentityNumber('12345678901');
    $customer->setEmail('noreply@kuveytturk.com.tr');
        $phone = new \KTPay\Models\Phone();
        $phone->setCc('90');
        $phone->setSubscriber('5001112233');
    $customer->setPhoneNumber($phone);
    $customer->setIpAddress((new KTPay\Helpers\KTPayHelper)->getClientIP());
$paymentRequest->setCustomer($customer);
    $card = new \KTPay\Models\Card();
    $card->setCardHolderName($cardConfig['cardHolderName']);
    $card->setCardNumber($cardConfig['cardNumber']);
    $card->setExpireMonth($cardConfig['expireMonth']);
    $card->setExpireYear($cardConfig['expireYear']);
    $card->setSecurityCode($cardConfig['securityCode']);
$paymentRequest->setCard($card);
    $cartItem1 = new \KTPay\Models\CartItem();
    $cartItem1->setCartItemName('Product PHYSICAL');
    $cartItem1->setCartItemUrl('https://www.kuveytturk.com.tr');
    $cartItem1->setCartItemType(KTPay\Models\CartItemType::PHYSICAL);
    $cartItem1->setQuantity(1.5);
    $cartItem1->setPrice('10');
    $cartItem1->setTotalAmount('15');
    $cartItem2 = new \KTPay\Models\CartItem();
    $cartItem2->setCartItemName('Product VIRTUAL');
    $cartItem2->setCartItemUrl('https://www.kuveytturk.com.tr');
    $cartItem2->setCartItemType(KTPay\Models\CartItemType::VIRTUAL);
    $cartItem2->setQuantity(1);
    $cartItem2->setPrice('85');
    $cartItem2->setTotalAmount('85');
$paymentRequest->setCart([$cartItem1, $cartItem2]);
    $invoiceAddress = new \KTPay\Models\InvoiceAddress();
    $invoiceAddress->setCompany('XXX LTD.STI.');
    $invoiceAddress->setTaxNumber('111111111');
    $invoiceAddress->setTaxOffice('XXXXXXXXX');
    $invoiceAddress->setAddress('ADDRESS');
    $invoiceAddress->setCity('IZMIT');
    $invoiceAddress->setState(KTPay\Models\State::Kocaeli);
    $invoiceAddress->setCountry(KTPay\Models\Country::TURKIYE);
    $invoiceAddress->setZipCode('123456');
$paymentRequest->setInvoiceAddress($invoiceAddress);
    $shippingAddress = new \KTPay\Models\ShippingAddress();
    $shippingAddress->setFullName('JOHN DOE');
    $shippingAddress->setAddress('ADDRESS');
    $shippingAddress->setCity('IZMIT');
    $shippingAddress->setState(KTPay\Models\State::Kocaeli);
    $shippingAddress->setCountry(KTPay\Models\Country::TURKIYE);
    $shippingAddress->setZipCode('123456');
    $paymentRequest->setShippingAddress($shippingAddress);
$paymentRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "OrderId": 203418187,
    "MerchantOrderId": "KTPay-PHP-1577368010",
    "MD": "OGoIEuSrswsJg3QnyNfpuClWcw0ji2SjbuVu+UptHnQy8wz6GERZrhtvaE6I3+F1"
  },
  "Success": true,
  "ResponseCode": "00",
  "ResponseMessage": "Kart doğrulandı.",
  "BusinessKey": 202406069999000000010245159,
  "TransactionTime": 1717685585
}

Satış ve Taksitli Satış - Provizyon

Request

$provisionRequest = new \KTPay\Models\Request\ProvisionRequest();
$provisionRequest->setLanguage(KTPay\Models\Language::TR);
$provisionRequest->setMerchantId($envConfig['merchantId']);
$provisionRequest->setCustomerId($envConfig['customerId']);
$provisionRequest->setUsername($envConfig['username']);
$provisionRequest->setOrderId(203418187);
$provisionRequest->setMerchantOrderId('KTPay-PHP-1577368010');
$provisionRequest->setAmount('100');
$provisionRequest->setMd('OGoIEuSrswsJg3QnyNfpuClWcw0ji2SjbuVu+UptHnQy8wz6GERZrhtvaE6I3+F1');
$provisionRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "OrderId": 203418187,
    "MerchantOrderId": "KTPay-PHP-1577368010"
  },
  "Success": true,
  "ResponseCode": "00",
  "ResponseMessage": "OTORİZASYON VERİLDİ",
  "BusinessKey": 202406069999000000010314698,
  "TransactionTime": 1717685609
}

İptal, İade ve Kısmi İade

Request

$saleReversalRequest = new \KTPay\Models\Request\SaleReversalRequest();
$saleReversalRequest->setLanguage(KTPay\Models\Language::TR);
$saleReversalRequest->setSaleReversalType(KTPay\Models\SaleReversalType::CANCEL); //SaleReversalType::DRAWBACK, SaleReversalType::PARTIAL_DRAWBACK
$saleReversalRequest->setMerchantId($envConfig['merchantId']);
$saleReversalRequest->setCustomerId($envConfig['customerId']);
$saleReversalRequest->setUsername($envConfig['username']);
$saleReversalRequest->setOrderId(203418187);
$saleReversalRequest->setMerchantOrderId('KTPay-PHP-1577368010');
$saleReversalRequest->setAmount('100');
$saleReversalRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "OrderId": 203418187,
    "MerchantOrderId": "KTPay-PHP-1577368010"
  },
  "Success": true,
  "ResponseCode": "00",
  "ResponseMessage": "OTORİZASYON VERİLDİ",
  "BusinessKey": 202406049999000000016077009,
  "TransactionTime": 1717685630
}

İşlem Sorgulama

Request

$getTransactionRequest = new \KTPay\Models\Request\GetTransactionRequest();
$getTransactionRequest->setLanguage(KTPay\Models\Language::TR);
$getTransactionRequest->setMerchantId($envConfig['merchantId']);
$getTransactionRequest->setCustomerId($envConfig['customerId']);
$getTransactionRequest->setUsername($envConfig['username']);
$getTransactionRequest->setOrderId(203418187);
$getTransactionRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "MerchantId": 496,
    "PosTerminalId": "VP008759",
    "OrderId": 203418187,
    "MerchantOrderId": "KTPay-PHP-1577368010",
    "CardHolderName": "JOHN DOE",
    "CardNumber": "51889655****0843",
    "CardType": "MasterCard",
    "TransactionTime": "2024-06-06T14:52:57.407",
    "IsCancellable": 0,
    "IsRefundable": 0,
    "IsPartialRefundable": 0,
    "OrderStatus": "Satış (1)",
    "LastOrderStatus": "İptal (6)",
    "OrderType": "Peşin (1)",
    "TransactionStatus": "Basarılı (1)",
    "FirstAmount": 1,
    "DrawbackAmount": 0,
    "CancelAmount": 1,
    "ClosedAmount": 0,
    "FEC": "TRY (0949)",
    "InstallmentCount": 0,
    "TransactionSecurity": "3d İşlem (3)",
    "ResponseCode": "00",
    "ResponseExplain": "İşlem gerçekleştirildi.",
    "BatchId": 548,
    "EndOfDayStatus": "Açık (1)",
    "EndOfDayTime": null,
    "ProvisionNumber": "136371",
    "Transactions": [
      {
        "OrderStatus": "Satış (1)",
        "TransactionTime": "2024-06-06T14:53:29.38",
        "BatchId": 548,
        "ProvisionNumber": "136371",
        "RRN": "415814236198",
        "Stan": "236198",
        "TransactionStatus": "Basarılı (1)",
        "ResponseCode": "00"
      },
      {
        "OrderStatus": "İptal (6)",
        "TransactionTime": "2024-06-06T14:53:49.9",
        "BatchId": 548,
        "ProvisionNumber": "136371",
        "RRN": "415814236199",
        "Stan": "236199",
        "TransactionStatus": "Basarılı (1)",
        "ResponseCode": "00"
      }
    ]
  },
  "Success": true,
  "ResponseCode": "Successfull",
  "ResponseMessage": "İşleminiz başarıyla gerçekleştirildi.",
  "BusinessKey": 202406069999000000010314881,
  "TransactionTime": 1717685648
}

İşlem Listeleme

Request

$getTransactionsRequest = new \KTPay\Models\Request\GetTransactionsRequest();
$getTransactionsRequest->setLanguage(KTPay\Models\Language::TR);
$getTransactionsRequest->setMerchantId($envConfig['merchantId']);
$getTransactionsRequest->setCustomerId($envConfig['customerId']);
$getTransactionsRequest->setUsername($envConfig['username']);
$getTransactionsRequest->setOrderId(203418187); // Opsiyonel filtre
$getTransactionsRequest->setMerchantOrderId("KTPay-PHP-1577368010"); // Opsiyonel filtre
$getTransactionsRequest->setOrderStatus(6); // Opsiyonel filtre
$getTransactionsRequest->setBatchId(548); // Opsiyonel filtre
$getTransactionsRequest->setStartDate('2024-01-01 00:00:00'); // Opsiyonel filtre
$getTransactionsRequest->setEndDate('2024-12-31 23:59:59'); // Opsiyonel filtre
$getTransactionsRequest->setHashData($envConfig['password']);

Response

{
  "Result": {
    "Transactions": [
      {
        "MerchantId": 496,
        "PosTerminalId": "VP008759",
        "OrderId": 203418187,
        "MerchantOrderId": "KTPay-PHP-1577368010",
        "CardHolderName": "JOHN DOE",
        "CardNumber": "51889655****0843",
        "CardType": "MasterCard",
        "TransactionTime": "2024-06-06T14:52:57.407",
        "IsCancellable": 0,
        "IsRefundable": 0,
        "IsPartialRefundable": 0,
        "OrderStatus": "Satış (1)",
        "LastOrderStatus": "İptal (6)",
        "OrderType": "Peşin (1)",
        "TransactionStatus": "Basarılı (1)",
        "FirstAmount": 1,
        "DrawbackAmount": 0,
        "CancelAmount": 1,
        "ClosedAmount": 0,
        "FEC": "TRY (0949)",
        "InstallmentCount": 0,
        "TransactionSecurity": "3d İşlem (3)",
        "ResponseCode": "00",
        "ResponseExplain": "İşlem gerçekleştirildi.",
        "BatchId": 548,
        "EndOfDayStatus": "Açık (1)",
        "EndOfDayTime": null,
        "ProvisionNumber": "136371"
      }
    ]
  },
  "Success": true,
  "ResponseCode": "Successfull",
  "ResponseMessage": "İşleminiz başarıyla gerçekleştirildi.",
  "BusinessKey": 202406049999000000016078180,
  "TransactionTime": 1717685800
}

Lisans

Bu proje MIT altında lisanslanmıştır. Ayrıntılar için LİSANS dosyasını inceleyin.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases 1

1.0.0 Latest
Jun 7, 2024

Packages

No packages published

Languages