Akış Diyagramları

Genel Entegrasyon Mimarisi

Bu diyagram BEX entegrasyonunda Merchant Backend, Client SDK, BEX Backend ve Issuer/Acquirer Banka rollerinin birbirleriyle nasıl konuştuğunu özetler.

Amaç

Temel aktörleri ve entegrasyon sınırlarını görünür kılmak.

Kim başlatır?

İlk adımı Merchant Backend, kullanıcı odaklı akışları Client SDK başlatır.

Kritik nokta

Client hiçbir zaman Generate Token servisini doğrudan çağıramaz.

Sonraki adım

Client tarafında Check Status ile doğru iş akışı seçilir.

Check Status Karar Ağacı

Check Status servisi tüm entegrasyon modelinin merkezidir. Aşağıdaki karar ağacı geliştiricinin hangi durumda hangi servise ilerleyeceğini açık biçimde gösterir.

CheckStatus (Hesap Durumu Sorgulama)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

CheckStatus servisi son kullanıcının BEX sisteminde güncel hesap durumunu sorgulamak, üye işyeri ile hesap eşleştirme ve kart listeleme gibi entegrasyonları sağlamak amacıyla kullanılacaktır. Ödeme servisi öncesinde ilgili servis çağırılarak son kullanıcının hesap durumuna göre aksiyon alınması gerekmektedir. Hesap durum statüleri aşağıdaki gibidir.

• Son kullanıcı BEX’e ilk defa ilgili üye işyeri üzerinden kayıt olmaktadır.
• BEX hesabı daha önce oluşturulmuş, ilgili işyerinde hiç işlem yapmamış.
• BEX hesabı daha önce oluşturulmuş ve ilgili işyerinde hesabını ilişkilendirmiş.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend token üretimi için ilgili isteği BEX API servislerine iletir.
3. BEX API oluşturduğu token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve CheckStatus isteği gönderir.
6. BEX SDK tanımlı token ile birlikte CheckStatus çağrısını BEX API servislerine gönderir.
7. BEX API iletilen token üzerinde doğrulama işlemini gerçekleştirir.
8. Doğrulama başarılı olduktan sonra kullanıcıya ait hesap durumu JSON formatında BEX SDK’ya iletilir.
9. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

LinkAccount (Hesap Eşleştirme)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

LinkAccount servisi daha önce BEX hesabı olan son kullanıcının ilgili üye işyerinde gerçekleştireceği ilk işlem için tek seferlik doğrulama kullanılarak hesabını ilişkilendireceği servistir.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend authorization token talebini BEX API servislerine iletir.
3. BEX API oluşturduğu token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve LinkAccount isteği gönderir.
6. BEX SDK hesap-kart eşleştirme işlemini başlatmak için LinkAccount çağrısını BEX API servislerine gönderir.
7. BEX API ilgili işlem için Issuer OTP Service üzerinden OTP sürecini tetikler.
8. OTP doğrulamasının gerekli olduğu bilgisi sistem tarafına döner ve son kullanıcıya OTP gönderimi gerçekleştirilir.
9. Son kullanıcı kendisine iletilen OTP bilgisini Client uygulaması üzerinden girer.
10. Client alınan OTP bilgisini BEX SDK aracılığıyla doğrulama için iletir.
11. BEX SDK OTP doğrulama isteğini BEX API servislerine gönderir.
12. BEX API doğrulama işlemini tamamlamak üzere talebi Issuer OTP Servisine iletir.
13. Issuer OTP Servis doğrulama sonucunu başarılı veya başarısız olarak BEX API’ye döner.
14. BEX API işlem sonucunu BEX SDK’ya iletir.
15. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

StoreCard (Kart Kayıt)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

StoreCard servisi son kullanıcının BEX hesabına üye işyeri üzerinden tüm kart ekleme istekleri için kullanılan servistir.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend authorization token talebini BEX API servislerine iletir.
3. BEX API oluşturduğu token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve StoreCard isteği gönderir.
6. BEX SDK kart ekleme işlemini başlatmak üzere ilgili isteği BEX API servislerine gönderir.
7. BEX API işlem kapsamında telefon doğrulamasının gerekli olup olmadığını kontrol eder.
8. Telefon doğrulaması gerekli ise kullanıcıya OTP doğrulama kodu gönderilir.
9. Kullanıcı kendisine iletilen OTP doğrulama kodunu Client uygulaması üzerinden girer.
10. Client girilen doğrulama bilgisini BEX SDK aracılığıyla BEX API servislerine iletir.
11. Telefon doğrulaması gerekli değil ise bu adım atlanır ve süreç doğrudan OTP doğrulama aşamasına geçer.
12. BEX API OTP üretim veya doğrulama isteğini Issuer OTP Servis tarafına iletir.
13. Son kullanıcıya banka tarafından OTP bilgisi gönderilir ve kullanıcı bu OTP bilgisini uygulama üzerinden girer.
14. BEX SDK kullanıcı tarafından girilen OTP bilgisini doğrulama amacıyla BEX API servislerine iletir.
15. BEX API OTP doğrulama sonucunu Issuer OTP Servis üzerinden alır.
16. Doğrulama tamamlandıktan sonra kart kayıt sonucu BEX SDK’ya iletilir.
17. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

ResendOTP (OTP Tekrar Gönder)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

ResendOtp SMS süresi dolduğunda veya son kullanıcı SMS’i alamadığında, mevcut doğrulama işlemini bozmadan aynı işlem için yeni SMS üretilmesini sağlayan servistir.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend authorization token talebini BEX API servislerine iletir.
3. BEX API oluşturduğu token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar.
6. Client OTP’nin yeniden gönderilmesi için ResendOtp isteğini BEX SDK üzerinden başlatır.
7. BEX SDK ilgili isteği BEX API servislerine iletir.
8. BEX API iletilen token üzerinde doğrulama yapar ve OTP yeniden gönderim limitlerini kontrol eder.
9. Kontrollerin başarılı olması durumunda BEX API Issuer OTP Servis üzerinden yeni OTP üretim sürecini tetikler.
10. Üretilen OTP son kullanıcıya SMS olarak gönderilir.
11. OTP gönderim sonucu önce BEX API’ye, ardından BEX SDK’ya iletilir.
12. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

VerifyOtp (OTP Doğrula)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

VerifyOtp Banka tarafından üretilen OTP değerinin Banka tarafında doğrulanmasını sağlayan servistir.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu Authorization Token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Son kullanıcı SMS ile aldığı OTP bilgisini Client ekranı üzerinden girer; Client OTP doğrulama işlemini başlatır ve Authorization Token bilgisini BEX SDK’ya iletir.
6. BEX SDK OTP kontrol isteğini BEX API’ye gönderir.
7. BEX API OTP doğrulama isteğini Issuer Banka servislerine iletir.
8. Issuer Banka OTP doğrulama sonucunu doğru / yanlış bilgisi ile BEX API’ye döner.
9. BEX API OTP kontrol sonucunu BEX SDK’ya iletir.
10. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

CardDelete (Kart Silme)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

Son kullanıcının BEX hesabındaki ilgili kartı kaldırmak için kullanılan servistir.

1. Client kart silme işlemi öncesinde Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend token üretimi için ilgili isteği BEX API servislerine iletir.
3. BEX API oluşturduğu AuthorizationToken bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve DeleteCard isteği gönderir.
6. BEX SDK, kart silme işlemi BEX API servislerine gönderir.
7. Doğrulama başarılı olduktan sonra ilgili kart kaydı sistemden silinir.
8. Kart silme işleminin sonucu BEX SDK’ya iletilir.
9. BEX SDK sonucu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

StartPayment (Kayıtlı Kartla Ödeme)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

Son kullanıcının BEX hesabında bulunan kayıtlı kartlar ile ödeme akışını başlattığı servistir.

StartPayment - OTP

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu authorization token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve SDK üzerinden kayıtlı kart ile ödeme isteğini gönderir.
6. BEX SDK ilgili ödeme isteğini BEX API servislerine iletir.
7. BEX API ödeme işlemine ilişkin gerekli kontrolleri gerçekleştirir ve banka tarafında OTP doğrulama sürecini başlatır.
8. Issuer banka son kullanıcıya OTP bilgisi gönderir.
9. Son kullanıcı kendisine iletilen OTP bilgisini Client ekranı üzerinden girer.
10. Client girilen OTP bilgisini BEX SDK’ya iletir.
11. BEX SDK OTP doğrulama isteğini BEX API’ye gönderir.
12. BEX API OTP doğrulama bilgisini banka tarafına iletir.
13. Banka doğrulama sonucunu BEX API’ye döner.
14. BEX API doğrulama sonucuna bağlı olarak ödemeyi tamamlama servisinde kullanacağı işleme özel oluşturduğu transactionId bilgisini BEX SDK’ya iletir.
15. BEX SDK OTP doğrulama sonucunu ve transactionId bilgisini Client uygulamasına aktarır.
16. Client aldığı transactionId bilgisini Merchant Backend’e iletir.
17. Merchant Backend ödeme tamamlama isteğini BEX API’ye gönderir.
18. BEX API ödeme provizyon / satış işlemini banka tarafında tamamlar.
19. Banka işlem sonucunu BEX API’ye döner.
20. BEX API ödeme sonucunu Merchant Backend’e iletir.
21. Merchant Backend ödeme sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

StartPayment – 3D

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu Authorization token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve SDK üzerinden kayıtlı kart ile ödeme isteğini gönderir.
6. 3D doğrulama gerektiğinde Client 3D ACS formunu almak için BEX SDK’ya istek iletir.
7. BEX SDK,bu isteği BEX API’ye gönderir.
8. BEX API 3D ACS form talebini issuer banka tarafına iletir.
9. Banka 3D ACS form bilgisini BEX API’ye döner.
10. BEX API ACS form yanıtını BEX SDK’ya iletir.
11. BEX SDK 3D ACS formunu Client uygulamasına iletir.
12. Son kullanıcı 3D şifresini Client ekranı üzerinden girer.
13. Girilen 3D şifresi banka tarafında doğrulanır.
14. Banka 3D doğrulama sonucunu BEX API’ye iletir.
15. BEX API doğrulama sonucuna bağlı olarak ödemeyi tamamlama servisinde kullanacağı işleme özel oluşturduğu transactionId bilgisini BEX SDK’ya iletir.
16. BEX SDK 3D doğrulama sonucunu ve transactionId bilgisini Client uygulamasına aktarır.
17. Client aldığı transactionId bilgisini Merchant Backend’e iletir.
18. Merchant Backend ödeme tamamlama isteğini BEX API’ye gönderir.
19. BEX API ödeme provizyon / satış işlemini banka tarafında tamamlar.
20. Banka işlem sonucunu BEX API’ye döner.
21. BEX API ödeme sonucunu Merchant Backend’e iletir.
22. Merchant Backend ödeme sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

StartPaymentwithRegisteredCard (Kart Kaydederek Ödeme)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

Son kullanıcının BEX hesabına hem kartını eklediği hem de eş zamanlı olarak ödeme işlemini yapabileceği servistir. İlgili kartın BEX hesabına eklenebilmesi için ödeme işleminin başarılı tamamlanması gerekmektedir.

StartPaymentwithRegisteredCard– Otp

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu Authorization token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar ve SDK üzerinden kart bilgilerini girerek ödeme isteğini gönderir.
6. BEX SDK kart bilgileri ile oluşturulan ödeme isteğini BEX API servislerine iletir.
7. BEX API ödeme işlemine ilişkin gerekli kontrolleri gerçekleştirir ve banka tarafında OTP doğrulama sürecini başlatır.
8. Issuer banka son kullanıcıya OTP bilgisi gönderir.
9. Son kullanıcı kendisine iletilen OTP bilgisini Client ekranı üzerinden girer.
10. Client girilen OTP bilgisini BEX SDK’ya iletir.
11. BEX SDK OTP doğrulama isteğini BEX API’ye gönderir.
12. BEX API OTP doğrulama bilgisini banka tarafına iletir.
13. Banka OTP doğrulama sonucunu BEX API’ye döner.
14. OTP doğrulaması başarılı olduktan sonra BEX API, ilgili kart kaydını pasif statüde oluşturur.
15. BEX API doğrulama sonucuna bağlı olarak ödemeyi tamamlama servisinde kullanacağı işleme özel oluşturduğu transactionId bilgisini BEX SDK’ya iletir.
16. BEX SDK OTP doğrulama sonucunu ve transactionId bilgisini Client uygulamasına aktarır.
17. Client aldığı transactionId bilgisini Merchant Backend’e iletir.
18. Merchant Backend ödeme tamamlama isteğini BEX API’ye gönderir.
19. BEX API ödeme provizyon / satış işlemini banka tarafında tamamlar.
20. Banka işlem sonucunu BEX API’ye döner.
21. Ödeme işlemi başarılı ise BEX API, pasif statüdeki kart kaydını aktif duruma günceller.
22. BEX API ödeme sonucunu Merchant Backend’e iletir.
23. Merchant Backend ödeme sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

StartPaymentwithRegisteredCard – 3D

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu Authorization token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client kendisine iletilen token değerini BEX SDK içerisine tanımlar; ardından kart bilgilerini girerek ödeme işlemini başlatır.
6. BEX SDK kart bilgileri ile oluşturulan ödeme isteğini BEX API servislerine iletir.
7. 3D doğrulama gerektiğinde Client 3D ACS formunu almak için BEX SDK’ya istek iletir.
8. BEX SDK bu isteği BEX API’ye gönderir.
9. BEX API 3D ACS form talebini issuer banka tarafına iletir.
10. Banka 3D ACS form bilgisini BEX API’ye döner.
11. BEX API ACS form yanıtını BEX SDK’ya iletir.
12. BEX SDK 3D ACS formunu Client uygulamasına iletir.
13. Son kullanıcı 3D şifresini Client ekranı üzerinden girer.
14. Girilen 3D şifresi banka tarafında doğrulanır.
15. Banka 3D doğrulama sonucunu BEX API’ye iletir.
16. 3D doğrulaması başarılı olduktan sonra BEX API ilgili kart kaydını pasif statüde oluşturur.
17. BEX API doğrulama sonucuna bağlı olarak ödemeyi tamamlama servisinde kullanacağı işleme özel oluşturduğu transactionId bilgisini BEX SDK’ya iletir.
18. BEX SDK 3D doğrulama sonucunu ve transactionId bilgisini Client uygulamasına aktarır.
19. Client aldığı transactionId bilgisini Merchant Backend’e iletir.
20. Merchant Backend ödeme tamamlama isteğini BEX API’ye gönderir.
21. BEX API ödeme provizyon / satış işlemini banka tarafında tamamlar.
22. Banka işlem sonucunu BEX API’ye döner.
23. Ödeme işlemi başarılı ise BEX API, pasif statüdeki kart kaydını aktif duruma günceller.
24. BEX API ödeme sonucunu Merchant Backend’e iletir.
25. Merchant Backend ödeme sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

Unlink (Merchant-Hesap Bağlantısını Kaldırma)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

Unlink servisi kullanıcının daha önce bir üye işyeri ile oluşturduğu ilişkiyi(linkleme) kaldırmak için kullanılır. Bu işlemden sonra merchant artık kullanıcıya ait kayıtlı kartları göremez ve işlem başlatamaz.

1. Client güvenli oturum başlatmak amacıyla Merchant Backend’e Authorization Token talebi gönderir.
2. Merchant Backend Authorization token üretim isteğini BEX API servislerine iletir.
3. BEX API oluşturduğu Authorization token bilgisini Merchant Backend’e döner.
4. Merchant Backend aldığı token bilgisini Client’a güvenli şekilde iletir.
5. Client bağlantı kaldırma işlemini başlatmak için iletilen token değeri ile birlikte unlink talebini Merchant Backend’e gönderir.
6. Merchant Backend aldığı unlink isteğini BEX API servislerine iletir.
7. BEX API bağlantı kaldırma işlemini gerçekleştirir ve Unlink Response bilgisini Merchant Backend’e döner.
8. Merchant Backend unlink işlem sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

Cancel (Ödemenin İptali)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

İptal işlemi ödeme henüz gün sonuna (settlement) girmemişken yapılan tam geri alma işlemidir. Genellikle aynı gün ve bankaya henüz aktarılmamış işlemler için kullanılır.

1. Merchant Backend iptal talebini BEX API servislerine iletir.
2. BEX API işlemin iptal edilebilir olup olmadığını kontrol eder.
3. İşlem iptale uygunsa BEX API isteği banka / VPOS servisine gönderir.
4. Banka iptal işlemini gerçekleştirir ve sonuç bilgisini BEX API’ye döner.
5. BEX API işlem sonucunu Merchant Backend’e iletir.
6. Merchant Backend iptal işlem sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.

Refund (Ödemenin İadesi)

Bu servisin çağırılması için, öncelikle üye işyerinin sunucusundan “Generate Token” servisi ile Authorization Token elde etmiş olması gerekiyor.

İade işlemi gün sonu süreci tamamlanmış ve işyeri hesabına aktarılmış tutarın tamamının veya bir kısmının (partial) son kullanıcıya geri gönderilmesidir.

1. Merchant Backend iade talebini BEX API servislerine iletir.
2. BEX API işlemin iade edilebilir olup olmadığını kontrol eder.
3. İşlem iadeye uygunsa BEX API isteği banka / VPOS servisine gönderir.
4. Banka iade işlemini gerçekleştirir ve sonuç bilgisini BEX API’ye döner.
5. BEX API işlem sonucunu Merchant Backend’e iletir.
6. Merchant Backend iade işlem sonucunu Client’a aktarır ve kullanıcıya uygun bilgilendirme gösterilir.