EFix Api Nasıl Kullanılır?

Efix Ödeme Hizmetleri A.Ş

Parça TL ve Oyun Pini için Api Entegrasyon Dokümanı

Version : 1.0.0
Yayınlanma Tarihi : 26/08/2024 Son Güncellenme Tarihi : 26/08/2024

Tanım
Efix Ödeme Hizmetleri A.Ş ile yetki verilen temsilciler arasında Parça TL ve Oyun Pini işlemleri ile ilgili metotların kullanımının bilgilerini içeren entegrasyon dokümanıdır.

Özellikler

Paket Listesi Sorgulama

Paket Satın Alma

Paket Satın Alma Durumu Sorgulama

Gün Sonu Mutabakat

Bakiye Sorgulama

Genel Bilgiler

Api ye yapılacak tüm istekler POST metodu ile yapılmalıdır.

Tüm işlemlerde Başarılı İşlem kodu 1 ’dir. Hata ile ilgi kodlar aşağıda listelenmiştir.

Tüm isteklerde sonuç JSON formatında yanıt vermektedir ve standart olarak aşağıdaki bilgileri içermektedir.

(bool) success İşlem durumu
(int) code İşlem kodu
(string) message İşlem sonuç mesajı

Test Ortamı url : https://apiv1.efixtest.com/

Canlı Ortam url : https://apiv1.efixfatura.com.tr/

İstek Yapısı

İstek yapılacak ip adresinin tanımlanması gerekmektedir. Tanımsız ip adreslerinden yapılan istekler sunucu tarafından reddedilecektir.

İstek Üst Bilgisinde (Header) Api-Key alanının olması zorunludur.

İstek alanlarında user_code ve password alanlarının olması zorunludur.

** Api-Key, user_code ve password alanları yetkilendirilen kullanıcıya operasyon birimi tarafından bildirilecektir.
** Tüm alanlar büyük küçük harf duyarlıdır. Burada yazıldığı gibi gönderilmelidir.

Kullanabilir Metotlar

Aşağıdaki metotlar dışındaki istekler sunucu tarafından reddedilecektir.

5.1. Paket Listesi Sorgulama ( /package-list )

Kullanıcının ödeme yapabileceği paket listesini bu metodu kullanarak listeye bilirsiniz.

5.1.1 - Gönderilecek Parametreler

(string) Api-Key Request Header Api Kodu Zorunlu
(string) user_code Request Body Kullanıcı Kodu Zorunlu
(string) password Request Body Kullanıcı Şifresi Zorunlu

5.2. Paket Satın Alma ( / package-buy)

Paket satın almak için bu metodu kullanabilirsiniz.

5.2.1 - Gönderilecek Parametreler

(string) Api-Key Request Header Api Kodu Zorunlu
(string) user_code Request Body Kullanıcı Kodu Zorunlu
(string) password Request Body Kullanıcı Şifresi Zorunlu
(int) package_id Request Body Paket ID bilgisi Zorunlu
(string) customer_payment_no Request Body TL ödemeleri için 10 haneli gsm numarası veya Oyun Pin ödemeleri için oyuncu numarası Zorunlu
(string) payment_no Request Body Benzersiz ödeme kodu (Max 10 Karakter) Zorunlu

5.3. Paket Satın Alma Durumu Sorgulama ( / package-buy-status)

Satın alınan paketin son durumunu sorgulamak için bu metodu kullanabilirsiniz.

5.3.1 - Gönderilecek Parametreler

(string) Api-Key Request Header Api Kodu Zorunlu
(string) user_code Request Body Kullanıcı Kodu Zorunlu
(string) password Request Body Kullanıcı Şifresi Zorunlu
(string) ref_code Request Body Satın alınan ürün için ürettiğiniz benzersiz ödeme kodu Zorunlu

5.4. Mutabakat Durum Sorgulama ( /package-reconciliation )

Belirtilen tarihteki mutabakat durumunu sorgulamak için bu metodu kullanabilirsiniz.

5.4.1 - Gönderilecek Parametreler

(string) Api-Key Request Header Api Kodu Zorunlu
(string) user_code Request Body Kullanıcı Kodu Zorunlu
(string) password Request Body Kullanıcı Şifresi Zorunlu
(string) date Request Body Tarih (yyyy-mm-dd formatında olmalıdır) Zorunlu
(int) confirmed_count Request Body Ödenen Talep sayısı Zorunlu
(decimal) confirmed_amount Request Body Ödenen Talep Tutarı Zorunlu
(int) canceled_count Request Body İptal Edilen Talep sayısı Zorunlu
(decimal) canceled_amount Request Body İptal Edilen Talep tutarı Zorunlu

5.5. Bakiye Sorgulama ( /balance )

Bakiye bilgisini bu metodu kullanarak sorgulayabilirsiniz.

5.5.1- Gönderilecek Parametreler

(string) Api-Key Request Header Api Kodu Zorunlu
(string) user_code Request Body Kullanıcı Kodu Zorunlu
(string) password Request Body Kullanıcı Şifresi Zorunlu

5.6 İşlem Sonuç Kodları ve Mesajları

Kod Mesaj
1 İşlem Başarılı
-1 Api Bilgileri Hatalı
-4 payment_no (Benzersiz Ödeme No) geçerli değil
-8 Api Erişim Yetkisi Yok
-9 Yetkisiz İp
-10 Ödeme Yetkiniz Bulunmamaktadır
-999 İşleminiz tanımlanmadı. Lütfen Tekrar Deneyiniz.

Aşağıda 5 api den 3 tanesinin request body resimleri eklendi.diğer 2 metot herhangi bir parametre almadan post edilmektedir.

https://testbackoffice.flyp.com.tr/auth/signin Adresine POST isteği yapılır.

Post isteği form-body den gönderilir.

Örnek POST İsteği
{
"username":"",
"password":""
}

Başarılı Bir İstekte Dönen Veri

Token Nasıl Kullanılır?

Dönen veriden access_token değerini Authorization Header ile gönderiniz.

Başarısız Bir İstekte Dönen Veri

NOT:Başarısız İstek Sonuç Açıklaması Size Bir Fikir Verebilir.