Ödeal Developer Portal'e Hoşgeldiniz

Bu Portal Ödeal'ın E-FaturaPos ve Sadepos hizmetlerinde güvenli ödeme ile entegre olunması için kullanılması gerekli olan entegrasyon döküman sayfasıdır.

Bu dökümantasyon, E-FaturaPos veya Sadepos ödeme uygulaması ile yapılacak olan satış işlemlerinin başlatılması ve ödeme işlemlerinin tamamlanması için gerekli olan fonksiyonları ve bu fonksiyonların bağlı olduğu kullanım profillerini içerir. Güvenli satış uygulama ve entegrasyon yapısına göre farklı profiller bulunmaktadır. Bu profiller Ödeal tarafından, kullanım durumunuza göre tanımlanmaktadır.

📘

Ödeal Hizmetleri Nelerdir ?

E-FaturaPos: E-FaturaPos, VUK 507 mevzuatı çerçevesinde çalışan ve cihaz üzerinden gerçekleştirilen bir işlemin ebelgesinin otomatik oluşturulmasını sağlayan hizmetidir.

SadePos: Sadepos, yazar kasa fonksiyonu taşımayan bir EFT Pos hizmetidir. Sadece ödeme/tahsilat alınabilir. Ebelge entegrasyonu bulunmamaktadır.


📘

Ödeal Servis URL'leri Nelerdir ?

stage url: https://stage.odealapp.com/api/v1
prod url: https://api.odealapp.com/api/v1

Profiller

  • Internal Basket : Sadece Ödeal uygulaması üzerinden işlemlerin alınarak ebelgenin oluşturulduğu profildir.
  • App2App : Cihazda bulunan İş Ortağı ve Ödeal uygulamalarının entegrasyonuyla ödeme işleminin gerçekleştirildiği profildir. İş Ortağı uygulamasında hazırlanan sepetin ödeme işlemi Ödeal uygulaması tarafından tamamlanır ve ebelge oluşturulur.
  • Device2Device : Ödeal Pos cihazına İş Ortağı cihazının tanımlandığı profildir. Ödeme işlemine İs Ortağı cihazından başlanır, Ödeal cihazı tarafında tamamlanır.
  • Direct Charge : Ödeal uygulaması üzerinden sadece ödeme/tahsilat işleminin alındığı profildir.
  • App to Direct Charge : Cihazda bulunan İş Ortağı ve Ödeal uygulamalarının entegrasyonuyla ödeme işleminin alındığı profildir. Sadece ödeme/tahsilat işleminin alındığı profildir. Direct Charge'dan farkı işlem tutarı cihazdan girilmez, İş Ortağı uygulamasından Ödeal'a iletilir.

Entegrasyon Servisleri

Birim : Birimlerin çekileceği servistir.Ürün eklemeden önce birim kodlarını çekilmeli, ilgili birimin id bilgisi ürün ekleme servisine geçilmelidir. App2App, Device2Device gibi Ödeal ile sepet entegrasyonu yapılan durumlarda Ödeal birim değerlerine uygun format kullanılmalıdır.

Ürün : Ürün bilgilerinin iletileceği servistir. Bu servis sadece, Internal Basket profilinde kullanımı zorunludur. Öncesinde birim listesi çekilmelidir. Bir işyerinin satışlarda kullandığı ürün/hizmetlerin tanımlanmasında kullanılan servistir. App2App, Device2Device gibi sepetin Ödeal ile sepet entegrasyonu yapılan durumlarda sepette ürün bilgileri Ödeal'ın istediği formatta gönderilmelidir.

Müşteri : Müşteri bilgilerinin nasıl iletileceği belirlenir. Bu servis sadece Internal Basket profilinde kullanımı zorunludur. Ödeme işlemine ait müşterinin bilgilerini alabilmek adına, tarafınızdan oluşturulması gereken servistir.

Çalışan : Çalışan bilgilerinizin iletilmesi için kullanılmalıdır.External profiller için çalışan bilgisi sepet içinde geleceği için gerekli değildir. Internal profile sahip kullanıcılar için açılabilir.Henüz dışarı açık olarak hizmet vermemektedir.

Sepet : İş ortakları ile işlemlerde sepet aktarımlarımda kullanılan servistir. Profile göre farklı entegrasyon modelleri kullanılmaktadır.

Geri Bildirim : Ödeme ile ilgili işlem sonucunun (satış, iptal) iş ortağına gönderildiği servistir. Ayrıca işlem sonrasında efatura bildirimlerinde de kullanılmaktadır.

Konfigürasyon : Konfigürasyon bilgilerinin kaydedilmesi gereken servistir. İş ortağı ile yapılan entegrasyonlarda iş ortağı tarafından açılması beklenen servislerle ilgili URL bilgilerinin Ödeal'a iletildiği servistir.

Rapor : İşlem detaylarının sunulduğu servistir. Belli bir tarih aralığında gerçekleşen işlemlerle ilgili bilgilerin alınabileceği servistir.