Developer Api Documentation

giriş

Bu bölüm aşağıdakileri açıklar: CepParam ödeme ağ geçidi API'si.


CepParam API'yi iş yazılımınıza uygulamak kolaydır. API'miz iyi biçimlendirilmiş URL'lerdir, cURL isteklerini kabul eder, JSON yanıtlarını döndürür.

You can use the API in test mode, which does not affect your live data. The API key is use to authenticate the request and determines the request is valid payment or not. For test mode just use the sandbox URL and In case of live mode use the live URL from section Ödemeyi Başlat .

Desteklenen Para Birimleri

Bu bölüm tarafından desteklenen para birimleri açıklanmaktadır. CepParam


CepParam allows to make transaction with below currencies. Any new currency may update in future.

Para Birimi Adı Para Birimi Sembolü Para Birimi Kodu
United States Dollar $ USD
Türkiye TL

API Anahtarını Alın

Bu bölüm, api anahtarınızı nasıl alabileceğinizi açıklar.


giriş yap CepParam tüccar hesabı. If you don't have any ? Buraya tıklayın

Bir sonraki adım bulmaktır API Anahtarı kontrol paneli kenar çubuğunuzdaki menü. Menüyü tıklayın.

API anahtarları orada bulunabilir. Genel anahtar ve Gizli anahtar. API isteğini başlatmak için bu anahtarları kullanın. Her seferinde tıklayarak yeni API anahtarı oluşturabilirsiniz. API Anahtarı Oluştur buton. Bu anahtarları kimseyle paylaşmayacağınızı unutmayın.

Ödemeyi Başlat

Bu bölüm, ödemeyi başlatma sürecini açıklar.


Ödemeyi başlatmak için örnek kodu takip edin ve parametrelere dikkat edin. Aşağıdaki API bitiş noktaları ile istekte bulunmanız gerekecektir.

Canlı Bitiş Noktası: https://www.cepparam.com/payment/initiate

Test Bitiş Noktası: https://www.cepparam.com/sandbox/payment/initiate

Test Modu Postası: test_mode@mail.com

Test Modu Doğrulama Kodu: 222666

Talep Yöntemi: POST

Aşağıdaki parametrelerle bitiş noktasına istekte bulunun.

Param Adı Param Türü Tanım
public_key string (50) Gerekli Genel API anahtarınız
identifier string (20) Gerekli Tanımlayıcı temel olarak sonunda ödemeyi tanımlamak içindir
currency string (4) Gerekli Para Birimi Kodu, Büyük Harf Yazılmalıdır. Örneğin. USD,EUR
amount decimal Gerekli Ödeme miktarı.
details string (100) Gerekli Ödemenizin veya işleminizin ayrıntıları.
ipn_url string Gerekli Anında ödeme bildiriminin URL'si.
success_url string Gerekli Ödeme başarısı yönlendirme url'si.
cancel_url string Gerekli Ödeme iptal yönlendirme url'si.
site_logo string/url Gerekli İş sitenizin logosu.
checkout_theme string İsteğe bağlı Checkout form theme dark/light. Default theme is light
customer_name string (30) Gerekli Müşteri adı.
customer_email string (30) Gerekli Müşteri geçerli e-posta adresi.
Örnek PHP kodu
<?php
$parameters = [
    'identifier' => 'DFU80XZIKS',
    'currency' => 'USD',
    'amount' => 100.00,
    'details' => 'Purchase T-shirt',
    'ipn_url' => 'http://example.com/ipn_url.php',
    'cancel_url' => 'http://example.com/cancel_url.php',
    'success_url' => 'http://example.com/success_url.php',
    'public_key' => 'your_public_key',
    'site_logo' => 'https://www.cepparam.com/assets/images/logoIcon/logo.png',
    'checkout_theme' => 'dark',
    'customer_name' => 'John Doe',
    'customer_email' => 'john@mail.com',

];

//live end point
$url = 'https://www.cepparam.com/payment/initiate';

//test end point
$url = 'https://www.cepparam.com/sandbox/payment/initiate';


$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS,  $parameters);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);

//$result contains the response back.
?>
Örnek Yanıtlar

//Error Response.
{
    "error": "true",
    "message": "Invalid api key"
}

//Success Response.
{
    "success": "ok",
    "message": "Payment Initiated. Redirect to url.",
    "url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}

Ödemeyi ve IPN'yi Doğrulayın

Bu bölüm, anında ödeme bildiriminizi alma sürecini açıklar.


Ödemeyi başlatmak için örnek kodu takip edin ve parametrelere dikkat edin. Aşağıdaki API bitiş noktaları ile istekte bulunmanız gerekecektir.

Bitiş Noktası: İş uygulamanızın ipn url'si.

Talep Yöntemi: POST

Aşağıdaki parametreleri alacaksınız.

Param Adı Tanım
status Ödeme başarı durumu.
identifier Tanımlayıcı temel olarak sonunda ödemeyi tanımlamak içindir.
signature Sonunda ödemenizi doğrulamak için bir karma imza.
data Veriler, ücretler, tutar, para birimi, ödeme işlemi kimliği vb. ile ilgili bazı temel bilgileri içerir.
Örnek PHP kodu

<?php

//Receive the response parameter
    $status = $_POST['status'];
    $signature = $_POST['signature'];
    $identifier = $_POST['identifier'];
    $data = $_POST['data'];

    // Generate your signature
    $customKey = $data['amount'].$identifier;
    $secret = 'YOUR_SECRET_KEY';
    $mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));

    $myIdentifier = 'YOUR_GIVEN_IDENTIFIER';

    if($status == "success" && $signature == $mySignature &&  $identifier ==  $myIdentifier){
        //your operation logic
    }
?>

Sizlere daha iyi hizmet sunabilmek için sitemizde çerezler kullanılmaktadır. Sitemizi kullanmaya devam ederek çerezlerin kullanımına izin vermiş olursunuz.
Detaylı bilgilere Çerezler, Gizlilik ve KVKK Politikalarımız ‘dan ulaşabilirsiniz.

İzin vermek