• +90 850 308 37 10
  • info@payb.co

Önkoşullar

Payb Geliştirici API’sini entegre etmeye başlamadan önce aşağıdakilere sahip olduğunuzdan emin olun:

  1. Aktif bir Payb satıcı hesabı.
  2. PHP ve Laravel ile API entegrasyonu ve web geliştirme konusunda temel bilgi.
  3. API isteklerini işlemek için güvenli ve erişilebilir bir web sunucusu.

Kimlik doğrulama

Payb Geliştirici API’sine erişmek için bir API anahtarına ihtiyacınız olacak. Payb satıcı hesabınıza giriş yapıp API bölümüne giderek API anahtarınızı alabilirsiniz. İstemci/Birincil Anahtarı ve Gizli Anahtarı Dikkatlice Kopyalayın . API anahtarınızı gizli tutun ve herkese açık olarak paylaşmayın.

Temel URL

API isteklerinin temel URL’si şöyledir:

ÜRETİM Modu için:

https://web.payb.co/api/v1/create-payment-order

SANDBOX Modu için:

https://web.payb.co/sandbox/api/v1/create-payment-order

Web Site Ödeme Alma Entegrasyonları

Kullandığınız e-ticaret paketine uygun olan Payb entegrasyonunu bu bölümde indirebilirsiniz. Lütfen entegrasyonu internet sitenize yüklemeden önce kurulum kılavuzunu inceleyiniz. Kurulum esnasında yapmanız gereken işlemler ve oluşabilecek hataların çözümleri kılavuzda bulunmaktadır. Payb yazılım ekibi size 7/24 yardımcı olmaktan mutluluk duyacak.

Entegrasyonumuzu kurduktan sonra Payb panelden API alanındaki size verilen API Key’leri web sitesi entegrasyon alanına kopyalayıp yapıştırın.

Flutter, React Native, Swift veya diğer uygulama alt yapıları ve  uygulama geliştirme Payb API’leri için bizimle iletişime geçmekten çekinmeyin.

Entegrasyonlar;

  1. KavunSoft E-Ticaret Sistemleri
  2. OpenCart
  3. PrestaShop
  4. WooCommerce
  5. WHMCS

Açık Kaynak Entegrasyonlarımız çok yakında sizlerle

Müşteriden satıcı olarak ödeme alabilmek için kullanıcının Payb tarafından üye işyeri olarak kaydedilmesi gerekir. Yönetici bir satıcı hesabını kaydedip onayladıktan sonra satıcı kendi paneline giriş yapabilir. Satıcı , geliştiriciler bölümündeki satıcı panelinden genel anahtarı , gizli anahtarı ve satıcı numarasını görecektir.

Ödeme Sayfası

  • Müşteriye ödeme sayfası açılacaktır.
  • Müşteri Payb’ye kayıtlı telefon numarasını (ödeme ağ geçidi için) yazacaktır
  • Daha sonra OTP(3D Secure Güvenli Ödeme) sayfasına ilerleyip telefonuna gelen kodu girecektir.
  • OTP(3D Secure Güvenli Ödeme) doğrulamasının ardından müşteri geçerli 4 Haneli Payb PIN(Şifre) girecektir.
  • Müşteri bakiyesi yeterli ise müşteri ödeme tamamlandı sayfasına yönlendirilecektir.

Süreç

Müşteriden satıcı olarak ödeme alabilmek için kullanıcının Payb tarafından Üye İşyeri (Kurumsal Satıcı) olarak kaydedilmesi gerekir. “Buraya tıklayarak başvuru yapabilirsiniz“ Payb bir satıcı hesabını kaydedip onayladıktan sonra satıcı kendi paneline giriş yapabilir. Satıcı , geliştirici seçenekleri ve etegrasyonlar bölümündeki satıcı panelinden  genel anahtarı , gizli anahtarı ve satıcı numarasını alacaktır . Lütfen bu özel anahtarları kimseyle paylaşmayın.

Ödeme Sayfası

  • Müşteriye ödeme sayfası açılacaktır.
  • Müşteri hesap numarasını (Payb‘de kayıtlı telefon numarasını) açılan panele yazacaktır.
  • Daha sonra 2 faktörlü (3D Secure) ödeme sayfasına yönlendirilecektir.
  • 2 faktörlü doğrulamayı onayladıktan sonra müşteri Payb‘e kayıtlı 4 haneli pinini girebileceği kod sayfasına yönlendirilecektir.
  • Müşterinin Payb hesabında para var ise ödeme anında çekilecektir.

Telefon Doğrulaması

Doğrulama Kodu

PIN Kodu Doğrulaması

Ödeme Başarılı

Satıcı web sitesinden / mağazasından ödeme işlemi:

Önce ödeme ağ geçidi sunucusunda bir ödeme emri oluşturulacaktır.

Ödeme Yap:

				
					$url = 'BASE_URL/api/v1/create-payment-order';
$amount = 'YOUR_AMOUNT';

$response = Http::post($url, [
    'public_key'=> 'YOUR_PUBLIC_KEY',
    'secret_key'=> 'YOUR_SECRET_KEY',
    'merchant_number'=> 'MERCHANT_NUMBER',
    'amount'=> $amount,
])->json();

Cevap:

				
					if($response['status'] == 'merchant_not_found'){
    //Merchant not found
}

if($response['status'] == 'payment_created'){
    return redirect()->away($response['redirect_url']. '&callback=' . $URL_YOU_WANT_TO_REDIRECT_AFTER_PAYMENT_DONE);
}

GERİ ÇAĞRI (Callback)

Satıcı, Payb Panel mağaza ayarlarından bir geri arama url’si ayarlayabilir, müşteri ödeme işlemini tamamladığında, bir işlem özeti oluşturulur ve verilen geri arama url’sine gönderilir.

				
					https://SENIN_WEB_SITE_ADRESIN/callback

Doğrulama

İşlem kimliği satıcı web sitesini kullanarak müşteri için ödemeyi doğrulayabilirsiniz:

İstek

				
					$transaction_id = 'GET_TRANSACTION_ID_FROM_REQUEST';
$payment_verification_url = 'https://4upay-url/api/v1/payment-verification';

$response = Http::post($payment_verification_url, [
    'public_key'=> 'YOUR_PUBLIC_KEY',
    'secret_key'=> 'YOUR_SECRET_KEY',
    'merchant_number'=> 'MERCHANT_NUMBER',
    'transaction_id' => $transaction_id,
])->json();

Başarılı Yanıt:

				
					{
  "payment_record": {
    "id": "6df7e156-69da-47d2-9d61-8464b4be0d42",
    "merchant_user_id": 66,
    "user_id": 57,
    "transaction_id": "Y37tR1674562943",
    "amount": 28,
    "callback": "https://url/4upay/callback",
    "is_paid": 1,
    "expired_at": "2023-01-24T12:27:12.000000Z",
    "created_at": "2023-01-24T12:22:12.000000Z",
    "updated_at": "2023-01-24T12:22:27.000000Z"
  }
}

Hata Yanıtı:

				
					{
  "errors": [
    {
      "code": "kod hatası",
      "message": "yanıt olarak gelen hata mesajı burada olacak"
    }
  ]
}

AYDINLATMA METNİ