MOBILEPAX ENTERPRISE API (WEB SERVİS)

Transkript

MOBILEPAX
ENTERPRISE API
(WEB SERVİS)
Versiyon: 1.0.5
: Bağlarbaşı Mh. Ergenekon Sk.
Çakmak Plaza N:6 Maltepe İstanbul
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Web Site : www.detaytelekom.com
Adres
İçindekiler
İçindekiler .......................................................................................................................................... 2
1. Belgenin Amacı ........................................................................................................................... 3
2. Sistem Gereksinimleri ................................................................................................................. 3
3. Belge Sürümleri........................................................................................................................... 3
4. Kullanım Şekli ............................................................................................................................. 3
4.1 Web’den Başlatma ......................................................................................................................... 3
4.1.1
Enterprise API Metotları: ........................................................................................................ 4
4.2
SMS ile Başlatma ............................................................................................................................ 6
4.3
Ödeme Bilgilerinin Geri Dönüşü..................................................................................................... 7
5.
4.3.1
MobilePaxSMSStart ................................................................................................................ 7
4.3.2
MobilePaxWEBStart................................................................................................................ 8
Hata Kodları .............................................................................................................................. 10
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
1. Belgenin Amacı
Enterprise API SOAP tabanlı bir entegrasyon sistemidir. Enterprise API’de satın alma işlemi boyunca satın
alma işlemini gerçekleştiren kullanıcı satın alma işlemini yaptığı site üzerinden başka bir siteye
yönlendirilmek zorunda değildir. Satın alma işlemini başlatmak için satın alınan ürünü veya hizmeti
Mobilepax servisine tanımlamanız gerekmez, GSM numarası ve tahsil edilecek tutarı göndererek satın
alma işlemini başlatabilirsiniz. Ancak SMS ile başlatma ve buton oluşturmak için ürünlerinizi yine de
Mobilepax sistemlerine tanımlamanız gerekmektedir. Bu doküman, üye iş yeri kullanıcılarının Mobilepax
servisini mobil tahsilatı gerçekleştirmelerini sağlamak amacıyla kendi sistemlerine entegre edebilmeleri
için hazırlanmıştır.
2. Sistem Gereksinimleri
Mobilepax Product çözümünü kullanabilmeniz için gereken minimum sistem gereksinimleri aşağıda
belirtilmiştir.
•
•
Windows 98 SE, ME, 2000, XP, UNIX, Linux ya da MacOS İşletim Sistemi
Internet Explorer 6 SP1 (Windows Platformu için)
3. Belge Sürümleri
Tarih
10.08.2009
08.09.2009
14.11.2009
17.08.2010
25.08.2010
13.01.2011
Sürüm
1.0.0
1.0.1
1.0.2
1.0.3
1.0.4
1.0.5
Açıklama
İlk sürüm
Hata Kodları Güncellendi
SMS ile Başlatma ve Web’den Başlatma Eklendi
Ödeme Bilgilerinin Geri Dönüşü Güncellendi
4. Kullanım Şekli
4.1 Web’den Başlatma
Merchantlar ödeme isteklerini aşağıdaki servis adresini kullanarak bize iletirler.
http://api.mobilepax.com/mobilepax.asmx
Servisin Wsdl dokümanına http://api.mobilepax.com/mobilepax.asmx?wsdl adresinden ulaşabilirsiniz.
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
4.1.1 Enterprise API Metotları:
•
Start Mobilepax
Request Data
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<startMobilePax xmlns="http://mobilepax.com/">
<merchantid>int</merchantid>
<username>string</username>
<password>string</password>
<gsmno>string</gsmno>
<paymenttype>int</paymenttype>
<chargingunit>string</chargingunit>
<chargingvalue>double</chargingvalue>
<productDescription>string</productDescription>
</startMobilePax>
</soap:Body>
</soap:Envelope>
Request Data - Parametre Değerleri
Merchantid
String username
String password
GSM No
Paymenttype
Chargingunit
Chargingvalue
ProductDescription
Üye İş Yeri Kodu
API'leri kullanmak için gerekli Üye İş Yeri Kullanıcı Adı (merchant
kodu) bilgisi
API'leri kullanmak için gerekli Üye İş Yeri Parola Bilgisi
Ödeme yapılacak GSM no
Ödeme tipi
SMS ya da TL cinsinden ödeme birimi
Ödeme alınacak tutar
Mesaj içinde ürün hakkında gidecek bilgi
ProductDescription Örnek: Armut işlem bedeli 2.4 TL. Onay için “Evet”; İptal için “Hayir” yazarak mesajı
cevaplayınız.
Not: Chargingvalue değerinde Nokta işareti kullanılmalıdır.
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
Paymenttype - Ödeme Tipi Adları ve Numaraları
TURKCELL MOBİL ÖDEME
2
3
4
5
6
29
30
34
36
37
59
38
61
63
73
Fiziksel Ürün %8
Aidat / Otomat / Abonelik
Dijital İçerik / Hizmet / Servis - 20 TL Altı
Arkadaşlık / Sosyal Ağ / Sohbet - 20 TL Altı
Online Oyun 20 TL altı
Arkadaşlık / Sosyal Ağ / Sohbet - 20 TL Üstü
Bahis
Online Oyun 20 TL Üstü
Kutulu Oyun
Dijital İçerik / Hizmet / Servis - 20 TL Üstü
Fırsat Siteleri
Sigorta
Mobil Bilet
Abonelik
Eğitim
AVEA MOBİL ÖDEME
10
11
12
13
33
39
40
41
42
43
58
72
74
75
76
Fiziksel Ürün
Dijital İçerik / Hizmet / Servis
Online Oyun
Arkadaşlık / Sosyal Ağ / Sohbet
Fiziksel Ürün 2
Aidat/Otomat
Etkinlik/Bilet
Grup İndirim
Kutulu Oyun
Film Kulübü
TURP
Eğitim
Oyun (Sadece Ön Ödemeli)
MyMediks
Sigorta
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
VODAFONE MOBİL ÖDEME
65
66
67
68
69
70
71
Biletleme / Fastfood / Kamu
Abonelik / Otomat
Arkadaşlık / Sosyal Ağ / Sohbet
Fiziksel Ürün
İçerik
İnternet Servisleri
Oyun
Response Data
<soap:Body>
<startMobilePaxResponse xmlns="http://mobilepax.com/">
<startMobilePaxResult>
<status>string</status>
<errcode>string</errcode>
<transactionid>string</transactionid>
</startMobilePaxResult>
</startMobilePaxResponse>
</soap:Body>
</soap:Envelope>
Response Data - Parametre Değerleri
Status: İşlem durumu (“ERR” dönerse işlem hatalı, “OK” dönerse işlem başarılı)
transactionId: Yapılan işleme ait dönen tekil ID.
4.2 SMS ile Başlatma
Ödeme yapılacak GSM numarasından servis numarasına üye iş yerine smskeyword’u ve ürün keyword
bilgisi yazılarak mesaj gönderilir. Üye iş yeri smskeyword bilgisi üyelik aktivasyonu yapılırken Mobilepax
destek birimleri tarafından verilir ancak ürünlere ait sms keywordleri ürün tanımlamaları yapılırken üye
iş yeri tarafından belirtilir.
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
Firma SMSkeyword= Mobiltim
ürün keywordu= test1 gönderilir.
mobiltim test1 yazılarak 8044’e mesaj gönderilir. Mesaj gönderildikten sonra Mobilepax tarafından SMS
gönderen son kullanıcıya onay mesajı döner. Bu onay mesajı üye iş yerinin ürünü eklerken belirtmiş
olduğu mesaj metnidir.
Müşteri gelen mesajı onaylayarak 8044’e geri dönüş yapar ve charging işlemi yapılır. Charging işlemi
başarılı ise üye iş yerinden 8 karakterli onay mesajı alınır ve son kullanıcıya SMS olarak gönderilir.
4.3 Ödeme Bilgilerinin Geri Dönüşü
Merchant (üye iş yeri) tarafından host edilecek servis detayları
Merchantlar yapılan isteğin durumunu kendilerine iletmemiz amacıyla taraflarında ekte verdiğimiz wsdl
dokümana uygun bir web servisi host ederler. Host edilen web servisiyle ilgili açıklamalar aşağıda
bulunmaktadır.
Web servisini doğru yazıp yazmadıklarını ise;
mobilepaxWStester.exe ile Windows komut satırından mobilepaxWStester.exe webservis URL’si (örn:
mobilepaxWStester.exe http://api.mobilepax.com/mobilepaxclient.asmx gibi) çalıştırdıklarında yazılım
web servisini doğru yazıp yazmadıklarını söyleyecektir.
Yazdığınız web servisini host edip bize URL’ini göndermeniz gerekmektedir.
• MobilePaxSMSStart
• MobilePaxWEBStart
4.3.1 MobilePaxSMSStart
SMS ile başlatılan işlemlerde geri dönüş için kullanılacak metot.
Request Data
<soap:Body>
<MobilePaxSMSStart xmlns="http://mobilepax.com/">
<TransactionId>string</TransactionId>
<ProductCode>string</ProductCode>
<GsmNo>string</GsmNo>
</MobilePaxSMSStart>
</soap:Body>
</soap:Envelope>
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
Request Data - Parametre değerleri
TransactionId: Sistem tarafından takip edilmek amacıyla oluşturulan tekil ID
ProductCode: İşlem yapılan ürün kodu
GsmNo: İşlemi başlatan GSM numarası
Response Data
<soap:Body>
<MobilePaxSMSStartResponse xmlns="http://mobilepax.com/">
<MobilePaxSMSStartResult>
<Status>string</Status>
<ProductMsg>string</ProductMsg>
<VarinatCode>string</VarinatCode>
</MobilePaxSMSStartResult>
</MobilePaxSMSStartResponse>
</soap:Body>
</soap:Envelope>
ProductMsg: Merchantın müşteriye döndüğü mesajın içeriğidir.
VarinatCode: Müşteriye dönen SMS içinde olan, ürüne ait, işleme ait, uygulamaya ait müşterinin
kullanım amacına göre değişen koddur.
4.3.2 MobilePaxWEBStart
Web ile başlatılan işlemlerde geri dönüş için kullanılacak metot.
Request Data
<soap:Body>
<MobilePaxWEBStart xmlns="http://mobilepax.com/">
<TransactionId>string</TransactionId>
<ChargingOK>boolean</ChargingOK>
</MobilePaxWEBStart>
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
</soap:Body>
</soap:Envelope
Request Data - Parametre Değerleri
TransactionId: Web’den başlatmak için kullanılan web servisinden dönen transactionId
ChargingOK: Müşteri tahsilat için gelen mesajı “Evet” yazarak onaylarsa “OK” döner. “Hayir” yazarsa
“ERR” döner. Zaman aşımı gerçekleşirse “ERR” döner.
Response Data
<soap:Body>
<MobilePaxWEBStartResponse xmlns="http://mobilepax.com/">
<MobilePaxWEBStartResult>
<Status>string</Status>
<ProductMsg>string</ProductMsg>
<VarinatCode>string</VarinatCode>
</MobilePaxWEBStartResult>
</MobilePaxWEBStartResponse>
</soap:Body>
</soap:Envelope>
ProductMsg: Merchantın müşteriye döndüğü mesajın içeriğidir.
VarinatCode: Yapılan işlemin sonucuyla ilgili, ödeme yapan numaraya bilgilendirme amacıyla gönderilen
ID.
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres
5. Hata Kodları
11
Web Servisine Boş Alan Gönderilemez
12
Hatalı MerchantId, Username veya Password
13
Charging Value Bir Seferde İzin Verilen Değerden Fazla
14
productDescription 50 karakterden Büyük
15
chargingunit SMS veya TL Girilebilir
16
Günlük Ödeme Limiti Aşıldı
17
Saatlik Ödeme Limiti Aşıldı
18
Üye İş Yeri Günlük Ödeme Limiti Aşıldı
99
Sistem Hatası. Tanımlanamayan Hata
Telefon : 0216 305 1 888
Faks
: 0216 305 2 522
Adres

MOBILEPAX ENTERPRISE API (WEB SERVİS)

Transkript

Benzer belgeler

web`den başlatma

mobılepax xml product apı kullanım şekli

Tamamlayıcı işletim talimatları, Manyetik dozlama

COM API v.1.1

efatura özel entegrasyon platformu