Shoppiyen Geliştirici Dokümantasyonu

<!-- Shoppiyen Quick Checkout Form -->
<form action="https://shoppiyen.com/checkout/quick" method="POST">
    <input type="hidden" name="api_id" value="12">
    <input type="hidden" name="amount" value="150.00">
    <input type="hidden" name="currency" value="TRY">
    <input type="hidden" name="description" value="Siparis #12345">
    <input type="hidden" name="order_id" value="ORDER-12345">
    <input type="hidden" name="success_url" value="https://yoursite.com/payment/success">
    <input type="hidden" name="cancel_url" value="https://yoursite.com/payment/error">
    <input type="hidden" name="ts" value="1710000000">
    <input type="hidden" name="signature" value="HMAC_SHA256_SIGNATURE">
    <button type="submit">Odeme Yap</button>
</form>

<?php
$apiId = 12;
$apiKey = 'YOUR_SECRET_API_KEY';
$amount = '150.00';
$currency = 'TRY';
$description = 'Sepet Odemesi';
$orderId = 'ORDER-12345';
$successUrl = 'https://yoursite.com/payment/success';
$cancelUrl = 'https://yoursite.com/payment/error';
$timestamp = (string) time();

$payload = [
    'api_id' => (string) $apiId,
    'amount' => $amount,
    'currency' => strtoupper($currency),
    'description' => $description,
    'order_id' => $orderId,
    'success_url' => $successUrl,
    'cancel_url' => $cancelUrl,
    'ts' => $timestamp,
];
ksort($payload);
$signature = hash_hmac('sha256', http_build_query($payload, '', '&', PHP_QUERY_RFC3986), $apiKey);

 echo '<form id="payForm" action="https://shoppiyen.com/checkout/quick" method="POST">';
 foreach ($payload as $key => $value) {
     echo '<input type="hidden" name="' . htmlspecialchars($key, ENT_QUOTES, 'UTF-8') . '" value="' . htmlspecialchars($value, ENT_QUOTES, 'UTF-8') . '">';
 }
 echo '<input type="hidden" name="signature" value="' . htmlspecialchars($signature, ENT_QUOTES, 'UTF-8') . '">';
 echo '</form>';
 echo '<script>document.getElementById("payForm").submit();</script>';
?>

<?php
function startQuickCheckout(): void
{
    $apiId = 12;
    $apiKey = 'YOUR_SECRET_API_KEY';
    $amount = '150.00';
    $currency = 'TRY';
    $description = 'Sepet Odemesi';
    $orderId = 'ORD-' . time() . '-' . random_int(1000, 9999);
    $successUrl = 'https://yoursite.com/payment/success.php';
    $cancelUrl = 'https://yoursite.com/payment/error.php';
    $timestamp = (string) time();

    $payload = [
        'api_id' => (string) $apiId,
        'amount' => $amount,
        'currency' => strtoupper($currency),
        'description' => $description,
        'order_id' => $orderId,
        'success_url' => $successUrl,
        'cancel_url' => $cancelUrl,
        'ts' => $timestamp,
    ];
    ksort($payload);
    $signature = hash_hmac('sha256', http_build_query($payload, '', '&', PHP_QUERY_RFC3986), $apiKey);

    echo '<form id="shoppiyenQuickForm" action="https://shoppiyen.com/checkout/quick" method="POST">';
    foreach ($payload as $key => $value) {
        echo '<input type="hidden" name="' . htmlspecialchars($key, ENT_QUOTES, 'UTF-8') . '" value="' . htmlspecialchars($value, ENT_QUOTES, 'UTF-8') . '">';
    }
    echo '<input type="hidden" name="signature" value="' . htmlspecialchars($signature, ENT_QUOTES, 'UTF-8') . '">';
    echo '</form>';
    echo '<script>document.getElementById("shoppiyenQuickForm").submit();</script>';
}
?>

Kullanılabilir banka gruplarını döndürür.

Örnek Yanıt:

{
    "result": [
        { "id": 1, "name": "Varsayılan" },
        { "id": 7, "name": "Halkbank" }
    ]
}

Örnek Yanıt:

{
    "result": [
        {
            "bta_id": 5,
            "bta_name": "Halkbank",
            "bta_fullname": "SHOPPIYEN A.Ş.",
            "bta_iban": "TR39 0001 2001 3100 0010 1025 75",
            "bta_description": "Havale açıklamasına sipariş numaranızı yazın"
        }
    ]
}

İstek Parametreleri:

Başarılı Yanıt:

{
    "message": "successful",
    "payment_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "ORD-12345"
}

Dönen payment_id değeri UUID formatındadır. Bu değeri durum kontrolünde kullanacaksanız /api/pay/bank_transfer/uuid/{payment_id} endpoint'ini çağırın. /api/pay/bank_transfer/control/{payment_id} endpoint'i ise canlıda havale takip numarası (br_tracking_no) bekler.

Quick Checkout havale/EFT onay callback'lerinde de status, order_id, uuid, hash, type=bank_transfer, amount, currency ve transaction_id alanları gönderilir. Güvenli onay için /api/sale/webhook/verify kullanılmalıdır.

veya UUID ile:

Canlıda payment_id alanına havale takip numarası (br_tracking_no) gönderilmelidir.

Yanıt:

{
    "result": {
        "br_tracking_no": "BT-1706789012-ABC123",
        "br_name": "Ahmet Yılmaz",
        "br_price": 150.00,
        "br_currency": "TRY",
        "br_bank_name": "Halkbank",
        "br_iban": "TR39...",
        "sale_status": 1,  // 0=Bekliyor, 1=Onaylandı, 2=İptal
        "sale_date": 1706789012
    }
}

Asıl test yöntemi: /api/pay/credit_card çağrısından dönen redirect_url ekranında 3D Onay, 3D Ret veya Bakiye Yetersiz butonlarından birini seçerek sonucu siz belirlersiniz.

curl -X POST "https://shoppiyen.com/api/pay/bank_transfer" \
  -H "api-key: YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_id": 99001,
    "amount": "150.00",
    "currency": "TRY",
    "order_id": "SBX-BT-1001",
    "client_ip": "1.1.1.1",
    "customer_name": "Test Kullanici",
    "customer_email": "test@example.com",
    "customer_phone": "905555555555"
  }'

Webhook URL'inizi Shoppiyen Paneli > Profil > API Ayarları bölümünden tanımlayabilirsiniz.

{
    "order_id": "ORD-12345",
    "hash": "5c3d2b3b0a1d9f...",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "status": "successful",
    "message": "successful",
    "type": "credit_card",
    "amount": 150.00,
    "currency": "TRY",
    "transaction_id": "a1258260-0331-49ad-ad86-5e9f_313"
}

Header: api-key: YOUR_API_KEY

{
    "order_id": "ORD-12345",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "status": "successful",
    "hash": "5c3d2b3b0a1d9f..."
}

{
    "success": true,
    "is_valid": true,
    "payment_confirmed": true,
    "official_status": "successful",
    "status_match": true,
    "hash_match": true,
    "order_id": "ORD-12345",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "mode": "quick_checkout_fallback"
}

Not: Quick Checkout akışlarında doğrulama sonucu mode=quick_checkout_fallback dönebilir. Bu beklenen davranıştır.