# 6. Ödeme Emri Başlatma Hizmeti
Ödeme emri başlatma işlemi havale, FAST ya da PÖS ödemesiyle sonuçlanabilir. Ödeme işleminin amacı kişiden kişiye para transferi, e-ticaret ödemesi gibi farklı ödeme türleri olabilir. Ödemenin amacına göre ÖBHS’nin ileteceği veri setinde farklılaşmalar olabilir.
Ödeme Emri Başlatma Hizmeti 5 temel akışdan oluşur:
- Ödeme Emri Başlatma İsteğinin tetiklenmesi: ÖHK ÖBHS mobil uygulama ya da websitesinden ödeme emrini başlatır.
- Ödeme Emri Rıza Hazırlanması: ÖBHS, “Ödeme Emri Başlatma” işlemi için izin oluşturulması isteğini HHS’ye iletir.
- Ödeme Emri Rızasının Yetkilendirilmesi: HHS, gerekli gördüğü durumlarda ÖHK’yı GKD ile doğrular ve ödeme emri rızasına erişim için erişim belirteci tanımlanmasını temin eder.
- Ödeme Emrinin Başlatılması: ÖBHS, “ödeme emri”ni HHS’ye iletir.
- Ödeme Emri Rıza Durumu, Ödeme Emri Durumu, Ödeme Emri Detayı Sorguları: ÖBHS, Ödeme Emri Rıza Durumu, Ödeme Emri Durumu, Ödeme Emri Detayı bilgilerini isteğe bağlı olarak sorgulayabilir.
Şekil 4: Ödeme Emri Başlatma Hizmeti Üst Düzey İş Akışı
# Ödeme Emri Başlatma Hizmeti için Erişim Adresleri (Endpoints)
Ödeme Emri Başlatma Hizmeti İçin Erişim Adreslerinin Etki Alanı (Scope) = “odeme_emri” olarak belirtilmelidir.
Tablo 6: Ödeme Emri Başlatma Hizmeti İçin Erişim Adresleri
| No | Kaynak | HTTP işlemi | Erişim Adresi | Zorunlu / İsteğe Bağlı | Yetkilendirme Türü | İmzalama | İstem Nesnesi | Yanıt Nesnesi |
|---|---|---|---|---|---|---|---|---|
| 1 | odeme-emri-rizasi | POST | POST /odeme-emri-rizasi | Z | İstemci Kimlik Bilgileri | İmzalı İstek ve Yanıt | OdemeEmriRizasiIstegi | OdemeEmriRizasi |
| 2 | erisim-belirteci (GKD için) | POST | POST/erisim-belirteci /odeme-emri-rizasi | Z | İstemci Kimlik Bilgileri | İmzalı İstek ve Yanıt | ErisimBelirteciIstegi | ErisimBelirteci |
| 2.1 | odeme-emri-rizasi | GET | GET /odeme-emri-rizasi/{rizaNo} | Z | İstemci Kimlik Bilgileri | İmzalı Yanıt | - | OdemeEmriRizaYaniti |
| 3 | odeme-emri | POST | POST /odeme-emri | Z | İstemci Kimlik Bilgileri & Yetkilendirme Kodu (GKD) | İmzalı Yanıt | OdemeEmriIstegi | OdemeEmri |
| 3.1 | odeme-emri | GET | GET /odeme-emri/{odemeEmriNo} | Z | İstemci Kimlik Bilgileri & Yetkilendirme Kodu (GKD) | İmzalı Yanıt | - | OdemeEmri |
# 6.1. ADIM 0 - Ödeme Emri Başlatma Isteği
- ÖHK, ÖBHS uygulamasında (web arayüzü/mobil uygulama) ödeme emri başlatma işlemine onay verir.
- Gönderen hesap detaylarının bu aşamada belirtilmesi zorunlu değildir.
# 6.2. ADIM 1 - Ödeme Emri Rızasının Hazırlanması
Şekil 5: Ödeme Emri Rızasının Hazırlanması
ÖBHS, ödeme hizmeti kullanıcı hesabının bulunduğu HHS’ye bağlanarak ödeme emri rıza kaynağının oluşturulmasını (odemeEmriRizasi) sağlar.
POST isteği TLS protokolü tesis edilen iletişim katmanı üzerinden gerçekleştirilir. TLS için nitelikli sertifikalar kullanılır.
POST isteğinin başlığındaki alanlar ve istemcinin sertifikasındaki özel alanlar kullanılarak istemcinin yetkilendirilmesi sağlanır:
- İstekte bulunan ÖBHS yetkilendirilmiş mi?
- İstekte bulunan yetkilendirilmiş ödeme hizmeti sağlayıcısı ÖBHS rolüne sahip mi?
- İstekte bulunulan HHS kodu doğru mu?
POST başarılı olursa, HHS, ödeme emri için içeride rıza olup olmamasına bakılmaksızın yeni bir rıza tanımlayıcısı RizaNo içeren odemeEmriRizasi yanıt olarak döner.
1 ÖHK'nın 1 YÖS için 1HHS'de istediği kadar rızası olabilir.
HHS tarafında RizaDurumu değişkeninin durumu “Yetki Bekleniyor” olarak güncellenir.
YÖS’ün doğrulama ekranı olarak ÖHK’ya açacağı URL adresini de ilgili rıza numarasına göre oluşturur. Burada 2 farklı yöntemle URL oluşturabilir.
- Statik URL :
HHS’nin base pathi/alt-dizin/{rızaNo}
Örnek hhsYonAdr : https://xbank.com.tr/ohvps/cb54834e36f742d09af3d534ece3352a
Bu adres için ilgili doğrulama sayfası önden hazırlanmalı ve ÖHK’nın doğrulama sayfasına erişimi için yayınlanmış olmalıdır (publish edilmelidir). - Dinamik URL:
HHS’nin base pathi/alt-dizin/GKD Karşılama Ekranı?rizano={rızano}
Örnek: https://xbank.com.tr/ohvps/gkd?rizano=cb54834e36f742d09af3d534ece3352a
- Statik URL :
POST /odeme-emri-rizasi
İSTEK:
ÖBHS, bu API erişim adresinden HHS’ye yeni bir OdemeEmriRizasi oluşturulması için istekte bulunur:
- ÖBHS, ödeme emri başlatma isteği olduğunu HHS’ye bildirir.
- ÖBHS, ÖHK’nın, ÖBHS arayüzünden verdiği rızanın (“Ön Onay”) bir kopyasının HHS nezdinde müşteri tarafından onaylanması için HHS’ye gönderilmesini sağlar.
- HHS; istek mesajında yer alan alanların API dökümanında belirtilen şartları sağlayacak şekilde zorunluluk, uzunluk ve içerik kontrollerini yapar. (Zorunlu)
- HHS; YÖS API ile alınan ÖBHS bilgilerinin içerisinde yer alan yönlendirme ve bildirim adresleri ile ödeme emri rızası nesnesi request mesajında paylaşılan adreslerin uyumlu olup olmadığının kontrollerini yapar. (Zorunlu)
- HHS; kimlik bilgileri nesnesinde eğer kimlik bilgileri iletilmiş ise; bu veri ile ÖHK’nın HHS müşterisi olup olmadığının kontrollerini yapar. Bu kontrol hem bireysel hem de kurumsal ÖHK’lar için yapılmalıdır. (Koşullu Zorunlu)
- HHS kimlik bilgisi ile gönderen unvanının uyumlu olduğunun kontrol eder. (Zorunlu)
- Gönderen Hesap Numarası ile ilgili Tablo7’de belirtilen kontroller yapılmalıdır. (Zorunlu)
- HHS, ödeme için benzersiz “RizaNo” ile “OdemeEmriRizasi” nesnesi oluşturur ve ÖBHS’ye döner.
- HHS, OdemeEmriRizasi oluşturduğu anda durumunu “Yetki Bekleniyor” olarak düzenler.
Bu aşamada ÖHK’nın HHS tarafından tanımlanmış ve isteğin veri alanında gönderen hesaba (borçlandırılacak hesaba) ilişkin bir bilgisinin olması gerekmez.
Hesap bakiye kontrolünün rıza aşamasında yapılmaması gerekmektedir. Çünkü ÖHK ödeme emri gerçekleşene kadar hesabına para eklemesi yapabilir.
POST /odeme-emri-rizasi isteğinin (REQUEST) gövdesinde (BODY) “odemeEmriRizasiIstegi” nesnesi (Tablo-7) kullanılır. İstek başarıyla sonuçlanırsa HHS kaynak sunucusunda “odemeEmriRizasi” (Tablo-8) nesnesi oluşturulur.
# BAŞARILI İSTEK:
Tablo 7: “OdemeEmriRizasiIstegi” nesnesi
| Alan Adı | JSON Alan Adı | Format: Veri modeli İsmi | Zorunlu / Koşullu / İsteğe bağlı | Açıklama | HHS tarafından ödeme emri rızası oluşturulması sırasında yapılması gereken kontrol ve işlemler |
|---|---|---|---|---|---|
| Katılımcı Bilgisi | katilimciBlg | Kompleks:KatilimciBilgisi | Z | Katılımcılara atanmış kod bilgileridir. | |
| >Hesap Hizmeti Sağlayıcısı Kodu | hhsKod | AN4 | Z | İsteğin iletildiği Hesap Hizmeti Sağlayıcısının kodudur. (Nezdinde ÖH bulunduran kuruluş kodu. Örneğin, Banka, Elektronik Para Kuruluşu ve Ödeme Kuruluşu) | HHS, hhsKod’un kendisine ait olduğunu ve istek başlığındaki x-aspsp-code değeri ile aynı olduğunu kontrol eder. Hata durumunda TR.OHVPS.Connection.InvalidASPSP hata kodunu döner. |
| > Yetkili Ödeme Hizmeti Sağlayıcısı Kodu | yosKod | AN4 | Z | İsteği gönderen Yetkili Ödeme Hizmeti Sağlayıcısı (YÖS) kodudur. | HHS, yosKod’un geçerli bir Ödeme Hizmeti Sağlayıcısı Kodu olduğunu ve istek başlığındaki x-tpp-code değeri ile aynı olduğunu kontrol eder. Hata durumunda TR.OHVPS.Connection.InvalidTPP hata kodunu döner. |
| GKD | gkd | Kompleks:Gkd | Z | ||
| > Yetkilendirme Yöntemi | yetYntm | AN1 | İ | TR.OHVPS.DataCode.GkdTur sıralı veri türü değerlerinden birini alır. Yetkilendirme yöntemi, ÖBHS tarafından belirtilmeyebilir. | HHS, ÖBHS’nin belirlediği yöntemi dikkate alarak kendi belirlediği yöntemi kullanır. |
| > Yönlenme Adresi | yonAdr | AN1..1024 | K | Yönlendirmeli güçlü kimlik doğrulama için zorunlu. YÖS’ün ileteceği adrestir. YÖS Yönlendirmeli GKD yöntemi ile akışı destekliyorsa, yetYntm değişkeninden bağımsız olarak yönlendirme adresini iletmelidir. Durum kodu(drmKod), yönlendirme adresine parametre olarak eklenmelidir. | HHS, müşteri uygulama / tarayıcısını bu alanda belirtilen adrese yönlendirir. |
| > Bildirim Adresi | bldAdr | AN1..1024 | K | Ayrık güçlü kimlik doğrulama için zorunlu. YÖS’ün ileteceği adrestir. YÖS Ayrık GKD yöntemi ile akışı destekliyorsa, yetYntm değişkeninden bağımsız olarak bildirim adresini iletmelidir. Durum kodu(drmKod), yönlendirme adresine parametre olarak eklenmelidir. | HHS, ayrık GKD sonrası bu alanda belirtilen adrese otorizasyon kodunu (authentication code) iletir. |
| Ödeme Başlatma | odmBsltm | Kompleks: OdemeBaslatma | Z | ||
| > Kimlik | kmlk | Kompleks:Kimlik | Z | ||
| >> Kimlik Türü | kmlkTur | AN1 | K | TR.OHVPS.DataCode.KimlikTur sıralı veri türü değerlerinden birini alır. | Çerçeve sözleşme kapsamındaki ödemelerde kullanımı zorunludur. HHS geçerli bir Kimlik Numarası Türü olduğunu kontrol eder. Kurum adına yapılan (ticari) ödemelerde, kurum adına işlem yapan kullanıcının kimlik türünün bu alanda gönderilmesi zorunludur. |
| >> Kimlik Verisi | kmlkVrs | AN1..30 | K | HHS nezdinde kullanıcı doğrulamasında kullanılan tanımlayıcıdır. TR.OHVPS.DataCode.KimlikTur değerine göre uzunluk ve formatı değişir. | Çerçeve sözleşme kapsamındaki ödemelerde kullanımı zorunludur. HHS, ÖBHS tarafından iletilmesi durumunda Kimlik Verisi üzeriden çapraz kontroller uygulamalı ve Kimlik Verisini temel alarak GKD gerçekleştirmelidir. Pasaport numarasına ilişkin kontroller HHS'nin halihazırda kullandığı veri, akış ve tabi olduğu diğer düzenlemelerdeki işleyiş ile aynı şekilde ele alınmalıdır. Kurum adına yapılan (ticari) ödemelerde, kurum adına işlem yapan kullanıcının kimlik türünün bu alanda gönderilmesi zorunludur. |
| >> Kurum Kimlik Türü | krmKmlkTur | AN1 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik türüdür. TR.OHVPS.DataCode.KurumKimlikTur sıralı veri türü değerlerinden birini alır. | Kurum adına yapılan (ticari) ödemelerde kullanımı zorunludur. HHS geçerli bir Kurum Kimlik Numarası Türü olduğunu kontrol eder. |
| >> Kurum Kimlik Verisi | krmKmlkVrs | AN1..30 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik verisidir. TR.OHVPS.DataCode.KurumKimlikTur değerine göre uzunluk ve formatı değişir. | Kurum adına yapılan (ticari) ödemelerde kullanımı zorunludur. HHS, ÖBHS tarafından iletilmesi durumunda Kurum Kimlik Verisi üzeriden çapraz kontroller uygulamalıdır. |
| >> Ödeme Hizmeti Kullanıcısı Türü | ohkTur | AN1 | Z | TR.OHVPS.DataCode.OhkTur sıralı veri türü değerlerinden birini alır (B: Bireysel, K:Kurumsal) | Kurum adına yapılan ödemelerde K değerini alır. Kurum Kimlik Türü ve Kurum Kimlik Verisi alanlarının girilmiş olduğu çapraz olarak kontrol edilir. |
| > İşlem Tutarı | islTtr | Kompleks:Tutar | Z | ||
| >> Para Birimi | prBrm | AN3 | Z | Para Birimi. Karekod akışında, FAST Karekod Veri Organizasyonundaki 53: (Para Birimi) alanında tanımlı Para Birimi verisi kullanılır. | HHS geçerli bir para birimi olduğu kontrol eder. |
| >> Tutar | ttr | N1..18 | Z | ÖBHS'nin ön yüzde kullanıcıdan teyit aldığı tutar. Karekod akışında, FAST Karekod Veri Organizasyonundaki 54: (Tutar) alanında tanımlı Tutar verisi kullanılır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. | |
| > Gönderen | gon | Kompleks:Hesap | İ | ||
| >> Unvan | unv | AN3..140 | İ | Gönderenin unvanıdır. HHS, bu bilgiyi ÖBHS sisteminden gelen veri yerine FAST’a iletirken kendi sisteminden alabilir. | HHS’nin bu veri ile kendi sistemlerindeki verinin farklı olması ve Kimlik Numarası ile eşleşmemesi durumunda ödeme emri başlatma isteği reddedilir. ÖBHS verisi ile HHS verisinin farklılaşması durumunun ise risk değerlendirme sistemlerine girdi olarak kullanması tavsiye edilir. |
| >> Hesap Numarası | hspNo | AN26 | İ | ÖBHS'nin ön yüzünden daha önce kayıt altına alınmış hesaplar arasından seçtirdiği veya müşteriye girdiği IBAN’dır. ÖBHS tarafından iletilmediği durumda, gönderen hesap bilgisini müşteri tarafından HHS’nin dijital kanalında GKD sonrasında seçilebilir. Bu amaçla ÖBHS arayüzünde HHS seçtirilmelidir. Hesap Referansı kullanılıyorsa Hesap Numarası kullanılmayabilir. Hesap referansı ile ödeme emri rızası başlatılacak ise HHS hesap referansı değeri ile ilişkilendirilmiş mevcut bir hesap bilgisi rızası var mı kontrol etmelidir. Eğer aktif bir rızası yok ise TR.OHVPS.Business.InvalidContent hatası verilmelidir. | ÖBHS tarafından iletildiği durumda; IBAN içerisindeki HHS kodunun istek başlığındaki HHS kodu ile aynı olduğu (hesabın HHS’ye aitliğinin kontrolü), IBAN’ın doğruluğu (kontrol basamağı doğrulaması), Hesap numarasının ÖHK’ya ait olduğu, HHS’ye özel ödeme izni verilmeyen farklı statülerin bulunması durumu kontrol edilir. Kontrol başarısız olduğunda TR.OHVPS.Business. InvalidAccount hatası YÖS’e iletilir. |
| >> Hesap Referansı | hspRef | AN5..40 | İ | HHS tarafından hesap için atanan biricik tanımlıyıcıdır (uuid). YÖS bazında farklılaşması gerekmez. ÖBHS’nin aynı zamanda HBHS olduğu durumda müşteri rızası tesis edilmiş bir hesabın referansı üzerinden de ödeme başaltılabilir. Hesap Numarası kullanılıyorsa Hesap Referansı kullanılmayabilir. | HspRef'e bağlı IBAN değiştiğinde yeni IBAN'ın da ilgili HspRef ile ilişkilendirilmesi beklenmektedir. Bu durumda, HBHS, HspRef ile sorguya geldiğinde HHS'nin yeni IBAN ve hesap hareketlerini dönebilmesi mümkün olacaktır. HspRef’in, IBAN değiştiğinde değiştirilmemesi tavsiye edilmektedir. |
| > Alıcı | alc | Kompleks:Hesap | Z | ||
| >> Unvan | unv | AN3..140 | K | Kolay Adres Sistemi kullanılmıyorsa zorunludur. Alıcının unvanıdır. ÖBHS ekranlarından girişi yapılabileceği gibi ÖBHS’nin kayıtlı alıcılarından yapılan seçimle de doldurup gönderebildiği bilgi olabilir. FAST-TR Karekod Veri Organizasyonunda; İşyeri tarafından sunulan uzun karekod yapısının 59: alanında tanımlı İşyeri adı alanıdır, Kişiden Kişiye Ödeme Karekod Yapısının 07: alanında tanımlı Ödeme Alıcısının Adı ve Soyadı alanıdır. FAST-TR Karekod dışındaki iş yeri ödemelerinde; yine Unvan alanında işyeri adı bilgisi gönderilmelidir. | |
| >> Hesap Numarası | hspNo | AN26 | K | Alıcının Hesap Numarası (IBAN) alanıdır. Kolay Adres Sistemi kullanılmıyorsa zorunludur. Karekod akışında, FAST Karekod Veri Organizasyonundaki 30-01: alanında tanımlı İş Yeri IBAN verisi kullanılır. Alıcının birden fazla hesabının kullanılabilir olduğu durumlarda (özellikle işyeri ödemelerinde HHS nezdindeki hesap (on-us havale akışı) tercih edilmelidir. | HHS (Gönderen Katılımcı) tarafından IBAN doğrulaması (kontrol basamağı doğrulaması) yapılır. |
| >> Kolay Adres | kolas | Kompleks:Kolas | K | ||
| >>> Kolas Türü | kolasTur | AN1 | Z | TR.OHVPS.DataCode.KolasTur sıralı veri türü değerlerinden birini alır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. | HHS (Gönderen FAST katılımcısı) tarafından KOLAS Servisine yapılan sorguda girdi olarak kullanılır. |
| >>> Kolas Değeri | kolasDgr | AN7..50 | Z | Müşterinin eklediği, HHS (FAST katılımcısı) tarafından doğrulanmış Kolay Adres değeridir. Alabileceği değerler BKM “Kolay Adresleme Sistemi Uygulama Kuralları” belgesinde tanımlıdır. Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. | HHS (Gönderen FAST katılımcısı) tarafından KOLAS Servisine yapılan sorguda girdi olarak kullanılır. |
| > Karekod | kkod | Kompleks:Karekod | K | ||
| >> Akış Türü | aksTur | AN2 | Z | TR.OHVPS.DataCode.KareKodAksTur sıralı veri değerlerinden birini alır. Kolay Adresi Sistemi ile birlikte kullanılmaz. | |
| >> Referansı | kkodRef | AN1..12 | K | Karekod referans numarasını gösterir. Okunan karekodda referans değeri varsa kullanılması zorunludur. Karekod ilke ve kurallar belgesinde tanımlandığı şekilde kullanılması gerekmektedir. Kolay Adresi Sistemi ile birlikte kullanılmaz. | |
| >> Üretici Kodu | kkodUrtcKod | AN4 | Z | Karekod üreticisinin kodu. Ödeme Hizmeti Sağlayıcıları ve TCMB tarafından uygun görülen ödeme sistemi işleticisi TR Karekod üretebilmek için BKM’ye kayıt başvurusu yaparak karekod üretici kodu alabileceklerdir. Bankalar EFT kodlarını kullanacak olup ayrıca kayıt yaptırmalarına gerek bulunmamaktadır. 4 haneden kısa değerlerin sol tarafı ’0’ karakteri ile tamamlanmalıdır. | |
| > Ödeme Ayrıntıları | odmAyr | Kompleks: OdemeAyrintilari | Z | ||
| >> Ödeme Kaynağı | odmKynk | AN1 | Z | Ödemenin başlatıldığı kaynağı belirtir. TR.OHVPS.DataCode.OdemeKaynak sıralı veri değerlerinden birini alır. | HHS geçerli bir Ödeme Kaynağı kodu kullanıldığını kontrol eder. |
| >> Ödeme Amacı | odmAmc | AN2 | Z | TR.OHVPS.DataCode.OdemeAmaci sıralı veri değerlerinden birini alır. Karekod akışında, FAST Karekod Veri Organizasyonundaki 62-08: alanında tanımlı Ödeme Amacı verisi kullanılır. | HHS geçerli bir Ödeme Amacı kodu olduğunu kontrol eder. |
| >> Referans Bilgisi | refBlg | AN1..140 | K | Ödemeye özel Referans Bilgisi alanıdır. Karekod işlemi değil ise zorunludur. - Kişiden kişiye fon aktarımlarda: Gün içerisinde ÖHK için biricik olarak oluşturan referans bilgisi - E-ticaret işlemlerinde sipariş/takip numarası/müşteri/abone numarası - Karekod akışında, FAST Karekod Veri Organizasyonundaki - 62-01: alanında tanımlı Fatura Numarası - 62-06: alanında tanımlı Müşteri Numarası verilerinden biri kullanılır. | HHS bu değeri GKD için kullandığı önyüzünde “işlem doğrulama kodunun” bir unsuru olarak göstermelidir. |
| >> Açıklama | odmAcklm | AN1..50 | İ | ÖBHS’nin ÖHK’dan aldığı ya da kendisinin atadığı işlem açıklaması bilgisi. | |
| > ÖBHS Masraf Tutarı | obhsMsrfTtr | Kompleks:Tutar | İ | ||
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). | |
| >> Tutar | ttr | N1..18 | Z | ÖBHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır.Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. | |
| İşyeri Ödeme Bilgileri | isyOdmBlg | Kompleks:IsyeriOdemeBilgileri | İ | İşyeri ödemelerinde kullanılabilecek alanlardır. Karekodlu işyeri ödemesi akışında bu alanlar dolu geldiği için isteğe bağlı olarak gönderilebilir. isyOdmBlg alanlarının en az birinin dolu olması durumunda istekte yer alır. | |
| > İşyeri Kategori Kodu | isyKtgKod | AN4 | İ | İşlemin, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). Ödeme Amacı = ‘06’ ya da ‘04’ olan ödeme işlemleri için doldurulabilir. 4 karakterden küçük değerlerin başına 0 eklenerek iletilmesi gereklidir. | |
| > Alt İşyeri Kategori Kodu | altIsyKtgKod | AN4 | İ | İşlem alt işyerinden gerçekleştiriliyorsa, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). 4 karakterden küçük değerlerin başına 0 eklenerek iletilmesi gereklidir. | |
| >Üye İş Yeri Tekil Kimlik | genelUyeIsyeriNo | AN8 | İ | İşyeri kayıt sisteminde kayıtlı İşyeri için BKM tarafından üretilmiş olan genel işyeri numarasıdır (GlobalMerchantId) 8 haneden küçük gönderiminde başa ‘0’ eklenmelidir. Örnek değer ‘01630618’ |
# BAŞARILI YANIT:
POST işleminin RESPONSE gövdesini (BODY) oluşturan “OdemeEmriRizasi” nesnesi Tablo-8’deki parametrelerden oluşur:
Tablo 8: “OdemeEmriRizasi” nesnesi
| Alan Adı | JSON Alan Adı | Format: Veri modeli İsmi | Zorunlu / Koşullu / İsteğe bağlı | Açıklama |
|---|---|---|---|---|
| Riza Bilgileri | rzBlg | Kompleks: RizaBilgileri | Z | |
| > Rıza No | rizaNo | AN1..128 | Z | OdemeEmriRızasi nesnesinin oluşturulması esnasında HHS kaynak sunucusu tarafından atanan biricik tanımlayıcı |
| > Oluşturma Zamanı | olusZmn | ISODateTime | Z | OdemeEmriRizasi nesnesinin oluşturulma zamanı |
| > Güncellenme Zamanı | gnclZmn | ISODateTime | Z | OdemeEmriRizasi nesnesinin güncellenme zamanı |
| > Rıza Durumu | rizaDrm | AN1 | Z | TR.OHVPS.DataCode.RizaDurumu sıralı veri tipini değerlerinden birini alır. |
| > Rıza Iptal Detay Kodu | rizaIptDtyKod | AN2 | K | Rıza durumunun iptal olduğu durumda zorunludur. Alabileceği değerler 4. Bölümde detaylandırılmıştır. |
| Katılımcı Bilgisi | katilimciBlg | Kompleks:KatilimciBilgisi | Z | Katılımcılara atanmış kod bilgileridir. |
| >Hesap Hizmeti Sağlayıcısı Kodu | hhsKod | AN4 | Z | İsteğin iletildiği Hesap Hizmeti Sağlayıcısının kodudur. (Nezdinde ÖH bulunduran kuruluş kodu. Örneğin, Banka, Elektronik Para Kuruluşu ve Ödeme Kuruluşu) |
| > Yetkili Ödeme Hizmeti Sağlayıcısı Kodu | yosKod | AN4 | Z | İsteği gönderen Yetkili Ödeme Hizmeti Sağlayıcısı (YÖS) kodudur. |
| GKD | gkd | Kompleks:Gkd | Z | |
| > Yetkilendirme Yöntemi | yetYntm | AN1 | Z | TR.OHVPS.DataCode.GkdTur sıralı veri türü değerlerinden birini alır. |
| > Yönlenme Adresi | yonAdr | AN1..1024 | K | Yönlendirmeli güçlü kimlik doğrulama için zorunlu. |
| > Bildirim Adresi | bldAdr | AN1..1024 | K | Ayrık güçlü kimlik doğrulama için zorunlu. |
| > HHS Yönlenme Adresi | hhsYonAdr | AN1..1024 | K | GKD doğrulama bilgilerinin girilebilmesi için uygulamadan açılacak yönlendirme sayfasının adresi |
| > Yetkilendirme Tamamlanma Zamanı | yetTmmZmn | ISODateTime | Z | Yetkilendirme akışının tamamlanması gereken son zamanı gösterir. HHS tarafından maksimum 5 dk içinde işlem tamamlanacak şekil zaman damgası oluşturulur. Zaman aşımı olduğunda HHS’nin GKD’ye izin vermeyecek şekilde hata mesajı vermesi gerekmektedir. Rıza durumu Yetkilendirildi statüsüne geçene kadarki süredir. |
| Ödeme Başlatma | odmBsltm | Kompleks: OdemeBaslatma | Z | |
| > Kimlik | kmlk | Kompleks:Kimlik | Z | |
| >> Kimlik Türü | kmlkTur | AN1 | K | TR.OHVPS.DataCode.KimlikTur sıralı veri türü değerlerinden birini alır. |
| >> Kimlik Verisi | kmlkVrs | AN1..30 | K | HHS nezdinde kullanıcı doğrulamasında kullanılan tanımlayıcıdır. TR.OHVPS.DataCode.KimlikTur değerine göre uzunluk ve formatı değişir. |
| >> Kurum Kimlik Türü | krmKmlkTur | AN1 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik türüdür. TR.OHVPS.DataCode.KurumKimlikTur sıralı veri türü değerlerinden birini alır. |
| >> Kurum Kimlik Verisi | krmKmlkVrs | AN1..30 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik verisidir. TR.OHVPS.DataCode.KurumKimlikTur değerine göre uzunluk ve formatı değişir. |
| >> Ödeme Hizmeti Kullanıcısı Türü | ohkTur | AN1 | Z | TR.OHVPS.DataCode.OhkTur sıralı veri türü değerlerinden birini alır (B: Bireysel, K:Kurumsal) |
| > İşlem Tutarı | islTtr | Kompleks:Tutar | Z | |
| >> Para Birimi | prBrm | AN3 | Z | Para Birimi. Karekod akışında, FAST Karekod Veri Organizasyonundaki 53: (Para Birimi) alanında tanımlı Para Birimi verisi kullanılır. |
| >> Tutar | ttr | N1..18 | Z | ÖBHS'nin ön yüzde kullanıcıdan teyit aldığı tutar. Karekod akışında, FAST Karekod Veri Organizasyonundaki 54: (Tutar) alanında tanımlı Tutar verisi kullanılır. |
| > Gönderen | gon | Kompleks:Hesap | İ | |
| >> Unvan | unv | AN3..140 | İ | Gönderenin unvanıdır. HHS, bu bilgiyi ÖBHS sisteminden gelen veri yerine FAST’a iletirken kendi sisteminden alabilir. |
| >> Hesap Numarası | hspNo | AN26 | İ | ÖBHS'nin ön yüzünden daha önce kayıt altına alınmış hesaplar arasından seçtirdiği veya müşteriye girdiği IBAN’dır. ÖBHS tarafından iletilmediği durumda, gönderen hesap bilgisini müşteri tarafından HHS’nin dijital kanalında GKD sonrasında seçilebilir. Bu amaçla ÖBHS arayüzünde HHS seçtirilmelidir. GKD sonrası HHS ekranında seçilen Hesap Numarası POST işleminin yanıtında dönülemez ancak isteğe bağlı GET sorgusu ile dönülebilir. Hesap Referansı kullanılıyorsa Hesap Numarası kullanılmayabilir. |
| >> Hesap Referansı | hspRef | AN5..40 | İ | HHS tarafından hesap için atanan biricik tanımlıyıcıdır (uuid). YÖS bazında farklılaşması gerekmez. ÖBHS’nin aynı zamanda HBHS olduğu durumda müşteri rızası tesis edilmiş bir hesabın referansı üzerinden de ödeme başaltılabilir. GKD sonrası HHS ekranında seçilen Hesap Referansı POST işleminin yanıtında dönülemez ancak isteğe bağlı GET sorgusu ile dönülebilir. Hesap Numarası kullanılıyorsa Hesap Referansı kullanılmayabilir. |
| > Alıcı | alc | Kompleks:Hesap | Z | |
| >> Unvan | unv | AN3..140 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen adres kaydı yaptırmış olan alıcının maskeli ad-soyadı veya maskeli ticari unvan bilgisidir. Kolas’tan dönen “account owner” alanı kullanılmalıdır. Kolay adres değil ise ÖBHS tarafından istek mesajında iletilen unvan bilgisidir. |
| >> Hesap Numarası | hspNo | AN26 | Z | ÖBHS tarafından istek mesajında iletilip doğrulanan veya Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen alıcı maskeli IBAN bilgisidir. |
| >> Kolay Adres | kolas | Kompleks:Kolas | K | |
| >>> Kolas Türü | kolasTur | AN1 | Z | TR.OHVPS.DataCode.KolasTur sıralı veri türü değerlerinden birini alır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. |
| >>> Kolas Değeri | kolasDgr | AN7..50 | Z | Müşterinin eklediği, HHS (FAST katılımcısı) tarafından doğrulanmış Kolay Adres değeridir. Alabileceği değerler BKM “Kolay Adresleme Sistemi Uygulama Kuralları” belgesinde tanımlıdır. Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. |
| >>> Kolas Referans Numarası | kolasRefNo | N12 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen, BKM Kolay Adresleme Sistemi Uygulama Kuralları’nda tanımlı KOLAS tarafından ilgili sorguya özel olarak üretilmiş referans numarasıdır. |
| >>> Kolas Hesap Türü | kolasHspTur | AN1 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen, BKM Kolay Adresleme Sistemi Uygulama Kuralları’nda tanımlı hesap türü bilgisidir: TR.OHVPS.DataCode.KolasHspTur sıralı veri değerlerinden birini alır. |
| > Karekod | kkod | Kompleks:Karekod | K | |
| >> Akış Türü | aksTur | AN2 | Z | TR.OHVPS.DataCode.KareKodAksTur sıralı veri değerlerinden birini alır. Kolay Adresi Sistemi ile birlikte kullanılmaz. |
| >> Referansı | kkodRef | AN1..12 | K | Karekod referans numarasını gösterir. |
| >> Üretici Kodu | kkodUrtcKod | AN4 | Z | Karekod üreticisinin kodu. Ödeme Hizmeti Sağlayıcıları ve TCMB tarafından uygun görülen ödeme sistemi işleticisi TR Karekod üretebilmek için BKM’ye kayıt başvurusu yaparak karekod üretici kodu alabileceklerdir. Bankalar EFT kodlarını kullanacak olup ayrıca kayıt yaptırmalarına gerek bulunmamaktadır. 4 haneden kısa değerlerin sol tarafı ’0’ karakteri ile tamamlanmalıdır. |
| > Ödeme Ayrıntıları | odmAyr | Kompleks: OdemeAyrintilari | Z | |
| >> Ödeme Kaynağı | odmKynk | AN1 | Z | Ödemenin başlattığı kaynağı belirtir. TR.OHVPS.DataCode.OdemeKaynak sıralı veri değerlerinden birini alır. |
| >> Ödeme Amacı | odmAmc | AN2 | Z | TR.OHVPS.DataCode.OdemeAmaci sıralı veri değerlerinden birini alır. Karekod akışında, FAST Karekod Veri Organizasyonundaki 62-08: alanında tanımlı Ödeme Amacı verisi kullanılır. |
| >> Referans Bilgisi | refBlg | AN1..140 | K | Ödemeye özel Referans Bilgisi alanıdır. Karekod işlemi değil ise zorunludur. - Kişiden kişiye fon aktarımlarda: Gün içerisinde ÖHK için biricik olarak oluşturan referans bilgisi - E-ticaret işlemlerinde sipariş/takip numarası/müşteri/abone numarası - Karekod akışında, FAST Karekod Veri Organizasyonundaki - 62-01: alanında tanımlı Fatura Numarası - 62-06: alanında tanımlı Müşteri Numarası verilerinden biri kullanılır. |
| >> Açıklama | odmAcklm | AN1..50 | İ | ÖBHS’nin ÖHK’dan aldığı ya da kendisinin atadığı işlem açıklaması bilgisi. |
| >> ÖHK Mesaj Alanı | ohkMsj | AN1..200 | İ | HHS’nin ÖHK’ya göstermek üzere ilettiği mesaj. |
| >> Ödeme Sistemi | odmStm | AN1 | Z | TR.OHVPS.DataCode.OdemeSistemi sıralı veri değerlerinden birini alır. |
| >> Beklenen Ödeme Zamanı | bekOdmZmn | ISODateTime | K | İşlemin yönlendirildiği ödeme sistemi PÖS ise ve PÖS işlem saatleri dışında ise işlemin yapılabileceği ilk zaman bilgisidir. Bu alan ileri vadeli ödemeler için düşünülmüştür. İlk fazda doldurulmasına gerek olmadığı düşünülmektedir. |
| > ÖBHS Masraf Tutarı | obhsMsrfTtr | Kompleks:Tutar | İ | |
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). |
| >> Tutar | ttr | N1..18 | Z | ÖBHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır.Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. |
| > HHS Masraf Tutarı | hhsMsrfTtr | Kompleks:Tutar | İ | |
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). |
| >> Tutar | ttr | N1..18 | Z | HHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. |
| İşyeri Ödeme Bilgileri | isyOdmBlg | Kompleks:IsyeriOdemeBilgileri | İ | İşyeri ödemelerinde kullanılabilecek alanlardır. Karekodlu işyeri ödemesi akışında bu alanlar dolu geldiği için isteğe bağlı olarak gönderilebilir. isyOdmBlg alanlarının en az birinin dolu olması durumunda yanıtta yer alır. |
| > İşyeri Kategori Kodu | isyKtgKod | AN4 | İ | İşlemin, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). Ödeme Amacı = ‘06’ ya da ‘04’ olan ödeme işlemleri için doldurulabilir. |
| > Alt İşyeri Kategori Kodu | altIsyKtgKod | AN4 | İ | İşlem alt işyerinden gerçekleştiriliyorsa, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). |
| >Üye İş Yeri Tekil Kimlik | genelUyeIsyeriNo | AN8 | İ | İşyeri kayıt sisteminde kayıtlı İşyeri için BKM tarafından üretilmiş olan genel işyeri numarasıdır (GlobalMerchantId) 8 haneden küçük gönderiminde başa ‘0’ eklenmelidir. Örnek değer ‘01630618’ |
# 6.3. ADIM 2- Ödeme Emri Rızasının Yetkilendirilmesi
Şekil 6: Ödeme Emri Rızasının Yetkilendirilmesi
ÖBHS, ÖHK’nın ödeme emrini yetkilendirmesi isteğini iletir. Ödeme emrinin yetkilendirilmesi, HHS tarafından gerçekleştirilen Yönlendirme veya Ayrık GKD yöntemiyle yapılır.
Yönlendirmeli doğrulama akışında, ÖBHS ÖHK’yı HHS’ye yönlendirir.
- ÖBHS tarafından yönlendirme, bir önceki adımdaki RizaNo’yu içerir.
- Yönlendirmenin RizaNo’yu içermesi sayesinde, HHS hangi ödeme emriyle ilişkili olarak yönlendirme yapıldığını ilişkilendirebilir.
- HHS, ÖHK için GKD sürecini işletir.
ÖHK’yı doğrularsa,
- ÖHK -bir önceki adımda seçmediyse- borçlu hesabını seçer.
- HHS, ödeme emri rıza kaynağının durumunu “Yetkilendirildi” olarak günceller.
- HHS, ÖHK’yı “olumlu yönlendirme akışı” ile ÖBHS tarafından tanımlanan yönlendirme adresine yönlendirir:
yonAdr?rizaDrm=Y&yetKod=xx&rizaNo=yy&rizaTip=O&drmKod=zzz
ÖHK’yı doğrulayamazsa,
1. HHS, ödeme emri rıza kaynağının durumunu “Yetki İptal” olarak günceller.
2. HHS, ÖHK’yı “olumsuz yönlendirme akışı” ile ÖBHS tarafından tanımlanan yönlendirme adresine yönlendirir:
yonAdr?rizaDrm=I&rizaNo=yy&rizaTip=O&drmKod=zzz
HHS tarafında oluşabilecek bir hata durumunun YÖS’e aktarılması gerektiği durumlar olabilir. Bu durumda yonlendirme adresinde hata kodu parametresi zorunlu olarak iletilmelidir.
Hata açıklamalarının neler olabileceği ve YÖS’ün kendi uygulamasında bu hatayı ne şekilde göstereceği aşağıda tariflenmiştir.
yonAdr?rizaDrm=I&rizaNo=yy&rizaTip=O&rizaIptDtyKod=11&drmKod=zzz
URL’de iletilen “Rıza İptal Detay Kodu” Rıza durumları bölümünde (4. Bölüm) belirtilen hata kodları ile aynı olacak şekilde tasarlanmıştır. GKD sırasında yapılması gereken kontroller 5.3 bölümünde detaylandırılmıştır.
- Ayrık doğrulama akışında, HHS, ÖHK’nın ödeme emrini başlattığı uygulamadan farklı olabilecek bir “doğrulama” uygulamasında işlemi doğrulamasını ister.
- Ayrık akış ÖBHS’nin farklı bir kanal kullanarak yetkilendirme isteği göndermesiyle başlatılır.
- Bu yetkilendirme isteği, yetkilendirilecek ödeme emri rızasının eşleştirileceği ÖHK’nın bulunması için ilgili veriyi taşır.
- HHS, ÖHK’yı doğrular.
- ÖHK -bir önceki adımda seçmediyse- borçlandırılacak hesabını seçer.
- HHS, ödeme emri rıza kaynağının durumunu “Yetkilendirildi” olarak günceller.
Başarılı GKD sonrasında (rizaDrm=’Y’) ilgili rıza nesnesi için (belirli bir rizaNo) yetkilendirme kodunun (yetKod) alınmasının ardından erişim belirteci erişim adresine POST çağrısı yapılarak yetkilendirme kodu karşılığında erişim belirteci ve yenileme belirteci alınır. POST /erişim-belirteci erişim noktası EK-3’te açıklanmıştır.
Erişim belirteci alındıktan sonra; HHS, ödeme emri rıza kaynağının durumunu “Yetki Kullanıldı” olarak günceller.
# 6.4. ADIM 2.1 – Ödeme Emri Rızasının Sorgulanması (isteğe bağlı)
Şekil 7: “odemeEmriRizasi” nesnesinin sorgulanması (isteğe bağlı)
GKD işleminin başarıyla tamamlanıp Ödeme Emri Rızasının yetkilendirilmesi esnasında, gönderen hesap seçiminin HHS ekranında yapıldığı durumlar olabilir. Bu durumlarda ödeme emri isteğinde gönderen hesap bilgileri alanının zorunlu olması nedeniyle, OdemeEmriRizasi nesnesi sorgulanarak gönderen hesap bilgileri (hesap numarası ve/veya hesap referansı) alınmalıdır. HHS, “ADIM 2 -Ödeme Emri Rızasının Yetkilendirilmesi” akışında ÖHK’nın hesapları arasında seçim yapmasını ve seçilen hesap bilgisinin OdemeEmriRizasi nesnesine işler.
GET /odeme-emri-rizasi/{RizaNo}
ÖBHS, mevcut durumunu kontrol etmek için, oluşturulan bir OdemeEmriRizasi kaynağının durumunu isteğe bağlı olarak alabilir.
Durum
OdemeEmriRizasi kaynağı için kullanılabilecek durum göstergeleri şu şekildedir:
- Yetki Bekleniyor
- Yetkilendirildi
- Yetki Kullanıldı
- Yetki Ödeme Emrine Dönüştü
- Yetki Sonlandırıldı
- Yetki İptal
Ödeme emri rıza durum değişiklikleri 4.2 bölümünde detaylandırılmıştır.
BAŞARILI YANIT:
GET /odeme-emri-rizasi/{RizaNo} yanıtının (RESPONSE) gövdesinde (BODY) “OdemeEmriRizasiİstegi” nesnesi kullanılır. İstek başarıyla sonuçlanırsa HHS kaynak sunucusunda Tablo-8’de yer alan parametreleri içeren “OdemeEmriRizasi” oluşturulur.
Gönderen Hesap Bilgisinin, ADIM 2 (Ödeme Emri Rızasının Yetkilendirilmesi) sonrasında HHS ekranından seçildiği akışta “OdemeEmriRizasi” nesnesi güncellenir ve ÖBHS GET /odeme-emri-rizasi/{RizaNo} isteği yaparak güncel gönderen hesap bilgisi bilgisini de içeren “OdemeEmriRizasi” nesnesini çekmelidir.
Çerçeve sözleşme kapsamında olmayan tek seferlik ödeme işlemlerinde, Kimlik Türü ve Kimlik Verisi bilgilerinin ödeme emri rızası sırasında gönderimi zorunlu değildir. Başarılı GKD sonrası, yani erişim belirteci alındığında, ödeme emri oluşmadan önce, YÖS’ün ödeme emri rızasını sorgulayarak bu bilgileri alması ve ödeme emrini oluştururken Kimlik Türü ve Kimlik Verisi alanlarını dolu olarak göndermesi beklenmektedir. Ancak rıza durumu “Yetki Bekleniyor - B”, “Yetkilendirildi - Y” ve “Yetki İptal - I” statülerinde ise, ödeme emri rızası sorgulamasında, HHS’nin Kimlik Türü ve Kimlik Verisi bilgisini YÖS ile paylaşmaması gerekmektedir.
# 6.5. ADIM 3- Ödeme Emrinin Oluşturulması
Şekil 8: Ödeme Emrinin Oluşturulması
POST /odeme-emri
- ÖHK’nın Güçlü Kimlik Doğrulama ile işlemi yetkilendirmesi sonrasında, ÖBHS OdemeEmri kaynağını oluşturur.
- Ödeme emri (OdemeEmri) uygun ödeme kaynağına POST isteği yapılarak başlatılır.
- POST HHS tarafından işlenir: RizaDurumu “Yetki Kullanıldı” ise işleme başlanır.
- POST /odeme-emri-rizasi ile POST /odeme-emri isteklerinde istek alanların aynı olması beklenmektedir. HHS tarafından kontrolü sağlanmalıdır.POST verisindeki Gönderen Hesap Numarası ve Alıcı Hesap Numarasının aynı bankaya aitse HAVALE değilse FAST veya PÖS iş akışına geçilir.
- POST verisinin modele göre kontrolü yapılır (alan kontrolleri)
- POST verisinin mantıksal kontrolleri yapılır (IBAN kontrolü, çapraz alan kontroller)
- OdemeEmriDurumu “Gerçekleşti” / “Gönderildi” / “Gerçekleşmedi” olarak güncellenir.
- POST başarılı olursa, içerisinde OdemeEmriNo ve OdemeEmriDurumu değişkenleri de bulunan OdemeEmri nesnesi ÖBHS’ye döner ve RizaDurumu değişkenin değeri “Yetki Ödeme Emrine Dönüştü” olarak güncellenir.
BAŞARILI İSTEK:
Tablo 9: “OdemeEmriIstegi” nesnesi
| Alan Adı | JSON Alan Adı | Format: Veri modeli İsmi | Zorunlu / Koşullu / İsteğe bağlı | Açıklama | HHS tarafından ödeme emri oluşturulması sırasında yapılması gereken kontrol ve işlemler | FAST A01 PÖS M01 mesaj mapping |
|---|---|---|---|---|---|---|
| Riza Bilgileri | rzBlg | Kompleks: RizaBilgileri | Z | |||
| > Rıza No | rizaNo | AN1..128 | Z | OdemeEmriRızasi nesnesinin oluşturulması esnasında HHS kaynak sunucusu tarafından atanan biricik tanımlayıcı | ||
| > Oluşturma Zamanı | olusZmn | ISODateTime | Z | OdemeEmriRizasi nesnesinin oluşturulma zamanı | ||
| > Rıza Durumu | rizaDrm | AN1 | Z | TR.OHVPS.DataCode.RizaDurumu sıralı veri tipini değerlerinden birini alır. | ||
| Katılımcı Bilgisi | katilimciBlg | Kompleks:KatilimciBilgisi | Z | Katılımcılara atanmış kod bilgileridir. | ||
| >Hesap Hizmeti Sağlayıcısı Kodu | hhsKod | AN4 | Z | İsteğin iletildiği Hesap Hizmeti Sağlayıcısının kodudur. (Nezdinde ÖH bulunduran kuruluş kodu. Örneğin, Banka, Elektronik Para Kuruluşu ve Ödeme Kuruluşu) | HHS, hhsKod’un kendisine ait olduğunu ve istek başlığındaki x-aspsp-code değeri ile aynı olduğunu kontrol eder. Hata durumunda TR.OHVPS.Connection.InvalidASPSP hata kodunu döner. | Gönderen katılımcı kodu (yani bankanın FAST/PÖS’teki Katılımcı kodu) |
| > Yetkili Ödeme Hizmeti Sağlayıcısı Kodu | yosKod | AN4 | Z | İsteği gönderen Yetkili Ödeme Hizmeti Sağlayıcısı (YÖS) kodudur. | HHS, yosKod’un geçerli bir Ödeme Hizmeti Sağlayıcısı Kodu olduğunu ve istek başlığındaki x-tpp-code değeri ile aynı olduğunu kontrol eder. Hata durumunda TR.OHVPS.Connection.InvalidTPP hata kodunu döner. | YosKod |
| GKD | gkd | Kompleks:Gkd | Z | |||
| > Yetkilendirme Yöntemi | yetYntm | AN1 | Z | TR.OHVPS.DataCode.GkdTur sıralı veri türü değerlerinden birini alır. | ||
| > Yönlenme Adresi | yonAdr | AN1..1024 | K | Yönlendirmeli güçlü kimlik doğrulama için zorunlu. | ||
| > Bildirim Adresi | bldAdr | AN1..1024 | K | Ayrık güçlü kimlik doğrulama için zorunlu. | ||
| > HHS Yönlenme Adresi | hhsYonAdr | AN1..1024 | K | GKD doğrulama bilgilerinin girilebilmesi için uygulamadan açılacak yönlendirme sayfasının adresi | ||
| > Yetkilendirme Tamamlanma Zamanı | yetTmmZmn | ISODateTime | Z | Yetkilendirme akışının tamamlanması gereken son zamanı gösterir. Rıza durumu Yetkilendirildi statüsüne geçene kadarki süredir. | ||
| Ödeme Başlatma | odmBsltm | Kompleks: OdemeBaslatma | Z | |||
| > Kimlik | kmlk | Kompleks:Kimlik | Z | |||
| >> Kimlik Türü | kmlkTur | AN1 | Z | TR.OHVPS.DataCode.KimlikTur sıralı veri türü değerlerinden birini alır. | Çerçeve sözleşme kapsamındaki ödemelerde kullanımı zorunludur. Ödeme Emri Rizası Nesnesindeki Kimlik Numarası Türü verisi ile aynı olmalıdır. Kurum adına yapılan (ticari) ödemelerde, kurum adına işlem yapan kullanıcının kimlik türünün bu alanda gönderilmesi zorunludur. | |
| >> Kimlik Verisi | kmlkVrs | AN1..30 | Z | HHS nezdinde kullanıcı doğrulamasında kullanılan tanımlayıcıdır. TR.OHVPS.DataCode.KimlikTur değerine göre uzunluk ve formatı değişir. | Çerçeve sözleşme kapsamındaki ödemelerde kullanımı zorunludur. HHS, ÖBHS tarafından iletilmesi durumunda Kimlik Verisi üzeriden çapraz kontroller uygulamalı ve Kimlik Verisini temel alarak GKD gerçekleştirmelidir. Ödeme Emri Rizası Nesnesindeki Kimlik Numarası verisi ile aynı olmalıdır. Gerçek kişi tarafından yapılan ödemelerde, 1. HHS, Gönderen Adı ve Gönderen Hesap Numarasını ödeme emri isteğinde (Havale/FAST/PÖS) gönderir. - Gönderen Adı ve diğer tüm müşteri bilgileri, Kimlik Numarası üzerinden elde edillir. Pasaport numarasına ilişkin kontroller HHS'nin halihazırda kullandığı veri, akış ve tabi olduğu diğer düzenlemelerdeki işleyiş ile aynı şekilde ele alınmalıdır. Kurum adına yapılan (ticari) ödemelerde, kurum adına işlem yapan kullanıcının kimlik verisi bu alanda gönderilebilmesi zorunludur. | GonKimN / Psp |
| >> Kurum Kimlik Türü | krmKmlkTur | AN1 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik türüdür. TR.OHVPS.DataCode.KurumKimlikTur sıralı veri türü değerlerinden birini alır. | Kurum adına yapılan (ticari) ödemelerde kullanımı zorunludur. Ödeme Emri Rizası Nesnesindeki Kurum Kimlik Türü verisi ile aynı olmalıdır. | |
| >> Kurum Kimlik Verisi | krmKmlkVrs | AN1..30 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik verisidir. TR.OHVPS.DataCode.KurumKimlikTur değerine göre uzunluk ve formatı değişir. | Kurum adına yapılan (ticari) ödemelerde kullanımı zorunludur. Ödeme Emri Rizası Nesnesindeki Kurum Kimlik Verisi ile aynı olmalıdır. | GonKimN / VKN |
| >> Ödeme Hizmeti Kullanıcısı Türü | ohkTur | AN1 | Z | TR.OHVPS.DataCode.OhkTur sıralı veri türü değerlerinden birini alır (B: Bireysel, K:Kurumsal) | Kurum adına yapılan ödemelerde K değerini alır. Kurum Kimlik Türü ve Kurum Kimlik Verisi alanlarının giilmiş olduğu çapraz olarak kontrol edilir. Ödeme Emri Rizası Nesnesindeki ÖHK Türü ile aynı olmalıdır. | |
| > İşlem Tutarı | islTtr | Kompleks:Tutar | Z | |||
| >> Para Birimi | prBrm | AN3 | Z | Para Birimi. Karekod akışında, FAST Karekod Veri Organizasyonundaki 53: (Para Birimi) alanında tanımlı Para Birimi verisi kullanılır. | Ödeme Emri Rizası Nesnesindeki Para Birimi verisi ile aynı olmalıdır. | |
| >> Tutar | ttr | N1..18 | Z | ÖBHS'nin ön yüzde kullanıcıdan teyit aldığı tutar. Karekod akışında, FAST Karekod Veri Organizasyonundaki 54: (Tutar) alanında tanımlı Tutar verisi kullanılır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. | Ödeme Emri Rizası Nesnesindeki İşlem Tutarı verisi ile aynı olmalıdır. HHS işlem tutarı ödeme mesajında (Havale/FAST/PÖS) aynen taşınmak durumundadır. | Ttr |
| > Gönderen | gon | Kompleks:Hesap | Z | |||
| >> Unvan | unv | AN3..140 | Z | Gönderen kişinin ad soyad ya da ticari unvan bilgisi. | HHS ve ÖBHS verisi tutarlı olmalıdır. ÖBHS verisi ile HHS verisinin farklılaşması durumunun ise risk değerlendirme sistemlerine girdi olarak kullanması tavsiye edilir. | GonAd |
| >> Hesap Numarası | hspNo | AN26 | K | ÖBHS'nin ön yüzünden seçtirdiği/kullanıcıya girdiği IBAN Hesap numarası ya da Hesap Referansı alanlarından en az birinin dolu olarak gelmesi gerekmektedir. | Ödeme Emri Rizası Yanıtı Nesnesindeki Gönderen Hesap Numarası verisi ile aynı olmalıdır. | GonHesN |
| >> Hesap Referansı | hspRef | AN5..40 | K | ÖBHS’nin aynı zamanda HBHS olduğu durumda müşteri rızası tesis edilmiş bir hesabın referansı üzerinden de ödeme başlatılabilir. GKD sonrası HHS ekranında seçilen Hesap Referansı POST işleminin yanıtında dönülemez ancak isteğe bağlı GET sorgusu ile dönülebilir. Hesap Numarası kullanılıyorsa Hesap Referansı kullanılmayabilir. | ||
| > Alıcı | alc | Kompleks:Hesap | Z | |||
| >> Unvan | unv | AN3..140 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen adres kaydı yaptırmış olan alıcının maskeli ad-soyadı veya maskeli ticari unvan bilgisidir. Kolay adres değil ise ÖBHS tarafından istek mesajında iletilen unvan bilgisidir. | YÖS’ten alıcı ad soyad bilgisi geliyorsa ve HHS'nin kontrolünden başarılı bir şekilde geçti ise HHS'nin tekrar alıcı ad soyad bilgisi için giriş yaptırmasına gerek bulunmamaktadır. | AlAd |
| >> Hesap Numarası | hspNo | AN26 | Z | Alıcının Hesap Numarası alanıdır (IBAN). Kolay Adres sorgusunda dönülen adres kaydı yaptırmış olan alıcının maskeli IBAN bilgisidir. Kolay adres değil ise ÖBHS tarafından istek mesajında iletilen IBAN bilgisidir. Karekod akışında, FAST Karekod Veri Organizasyonundaki 30-01: alanında tanımlı İş Yeri IBAN verisi kullanılır. | Ödeme Emri Rizası Yanıtı Nesnesindeki Alıcı Hesap Numarası verisi ile aynı olmalıdır. Kontroller başarıyla sonuçlanırsa, bilgi FAST/PÖS AlHesN alanına doğrudan aktarır ve FAST/PÖS Alan Katılımcı Kodu (AlKK) olarak Alıcı HHS Kodu kullanılır. KOLAS sorgusu sonucunda ödeme emrinde iletilen maskeli bilgi ile HHS’nin kendi ödeme emri rızası isteğinde tuttuğu KOLAS sorgusundan dönülen bilgi maskelenerek karşılaştırılır. Eğer aynı değilse uygun hata kodu dönülerek işlem sonlandırılır. | AlHesN |
| >> Kolay Adres | kolas | Kompleks:Kolas | K | |||
| >>> Kolas Türü | kolasTur | AN1 | Z | Müşterinin sorgulamak istediği Kolay Adres Tipi değeridir. TR.OHVPS.DataCode.KolasTur sıralı veri türü değerlerinden birini alır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. | Ödeme Emri Rizası Yanıtı Nesnesindeki Kolay Adres Tipi verisi ile aynı olmalıdır. | |
| >>> Kolas Değeri | kolasDgr | AN7..50 | Z | Müşterinin eklediği, HHS (FAST katılımcısı) tarafından doğrulanmış Kolay Adres değeridir. Alabileceği değerler BKM “Kolay Adresleme Sistemi Uygulama Kuralları” belgesinde tanımlıdır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. | Ödeme Emri Rizası Yanıtı Nesnesindeki Kolay Adres Değeri verisi ile aynı olmalıdır. | FAST (KolasRef) |
| >>> Kolas Referans Numarası | kolasRefNo | N12 | Z | Ödemeye özel Referans Bilgisi alanıdır. Karekod işlemi değil ise zorunludur. - Kişiden kişiye fon aktarımlarda: Gün içerisinde ÖHK için biricik olarak oluşturan referans bilgisi - E-ticaret işlemlerinde sipariş/takip numarası/müşteri/abone numarası - Karekod akışında, FAST Karekod Veri Organizasyonundaki - 62-01: alanında tanımlı Fatura Numarası - 62-06: alanında tanımlı Müşteri Numarası verilerinden biri kullanılır. | Ödeme Emri Rizası Nesnesindeki Referans Bilgisi verisi ile aynı olmalıdır. FAST: KareKod ile başlatılan işlemlerde FAST A01 mesajındaki Karekod Referansı (KrkdRef) alanına karşılık gelir. Bu durumda, FAST A01 mesajı alanları “FAST Mesaj Yapısı ve İşlem Türleri” belgesin uygun şekilde oluşturulur: KareKod (KrKd) bölümündeki Karekod Akış Türü (KrkdAksTur) ve Karekod Referansı (KrkdRef) alanları doldurulmalıdır. Kişiden kişiye fon aktarımlarında ve e-ticaret işlemelerinde Referans Bilgisi (RefBlg) alanı doldurulur. | FAST (KrkdRef) ve (RefBlg) |
| >>> Kolas Hesap Türü | kolasHspTur | AN1 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen, BKM Kolay Adresleme Sistemi Uygulama Kuralları’nda tanımlı hesap türü bilgisidir: TR.OHVPS.DataCode.KolasHspTur sıralı veri değerlerinden birini alır. | ||
| > Karekod | kkod | Kompleks:Karekod | K | |||
| >> Akış Türü | aksTur | AN2 | Z | Karekod Akış Türü Karekod ödemesinin hangi akışla gerçekleştirildiğini gösterir. Kolay Adresi Sistemi ile birlikte kullanılmaz. 01: FAST katılımcısından dinamik doğrulama hizmeti alınan işyeri ödemesi 02: FAST katılımcısından statik doğrulama hizmeti alınan işyeri ödemesi 03: Kişiden kişiye ödemeler | Ödeme Emri Rizası Nesnesindeki Kare Kod Akış Türü verisi ile aynı olmalıdır. | FAST: KrkdAksTur |
| >> Referansı | kkodRef | AN1..12 | K | Karekod referans numarasını gösterir. Okunan karekodda referans değeri varsa kullanılması zorunludur. Kolay Adresi Sistemi ile birlikte kullanılmaz. | Ödeme Emri Rizası Nesnesindeki Karekod Referansı verisi ile aynı olmalıdır. Çevrimiçi doğrulama hizmeti alınmayan statik karekodlar için Referans numarasının bulunmadığı durumlarda HHS tarafından “NONREF” ifadesi girilir. | FAST: Karekod Referansı (KrkdRef) |
| >> Üretici Kodu | kkodUrtcKod | AN4 | Z | Karekod üreticisinin kodu. Ödeme Hizmeti Sağlayıcıları ve TCMB tarafından uygun görülen ödeme sistemi işleticisi TR Karekod üretebilmek için BKM’ye kayıt başvurusu yaparak karekod üretici kodu alabileceklerdir. Bankalar EFT kodlarını kullanacak olup ayrıca kayıt yaptırmalarına gerek bulunmamaktadır. 4 haneden kısa değerlerin sol tarafı ’0’ karakteri ile tamamlanmalıdır. | ||
| > Ödeme Ayrıntıları | odmAyr | Kompleks: OdemeAyrintilari | Z | |||
| >> Ödeme Kaynağı | odmKynk | AN1 | Z | Ödemenin başlattığı kaynağı belirtir. TR.OHVPS.DataCode.OdemeKaynak sıralı veri değerlerinden birini alır. | Ödeme Emri Rizası Nesnesindeki Ödeme Kaynağı verisi ile aynı olmalıdır. HHS tarafından ödeme mesajında (FAST/PÖS) aynen taşınmak durumundadır. | FAST/PÖS: OdmKynk |
| >> Ödeme Amacı | odmAmc | AN2 | Z | TR.OHVPS.DataCode.OdemeAmaci sıralı veri değerlerinden birini alır. | Ödeme Emri Rizası Nesnesindeki Ödeme Amacı verisi ile aynı olmalıdır. HHS tarafından ödeme mesajında (FAST/PÖS) aynen taşınmak durumundadır. | FAST (OdmAmc)/PÖS(OdmAmaci) |
| >> Referans Bilgisi | refBlg | AN1..140 | K | Ödemeye özel Referans Bilgisi alanıdır. Karekod işlemi değil ise zorunludur. - Kişiden kişiye fon aktarımlarda: Gün içerisinde ÖHK için biricik olarak oluşturan referans bilgisi - E-ticaret işlemlerinde sipariş/takip numarası/müşteri/abone numarası - Karekod akışında, FAST Karekod Veri Organizasyonundaki - 62-01: alanında tanımlı Fatura Numarası - 62-06: alanında tanımlı Müşteri Numarası verilerinden biri kullanılır. | FAST (KrkdRef) ve (RefBlg) | |
| >> Açıklama | odmAcklm | AN1..50 | İ | ÖBHS’nin ÖHK’dan aldığı ya da kendisinin atadığı işlem açıklaması bilgisi. | FAST/PÖS Acklm | |
| >> ÖHK Mesaj Alanı | ohkMsj | AN1..200 | İ | HHS’nin ÖHK’ya göstermek üzere ilettiği mesaj. | ||
| >> Ödeme Sistemi | odmStm | AN1 | Z | TR.OHVPS.DataCode.OdemeSistemi sıralı veri değerlerinden birini alır. | Ödeme Emri Rizası Nesnesindeki Ödeme Sistemi verisi ile aynı olmalıdır. | |
| >> Beklenen Ödeme Zamanı | bekOdmZmn | ISODateTime | K | İşlemin yönlendirildiği ödeme sistemi PÖS ise ve PÖS işlem saatleri dışında ise işlemin yapılabileceği ilk zaman bilgisi | ||
| > ÖBHS Masraf Tutarı | obhsMsrfTtr | Kompleks:Tutar | İ | |||
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). | Ödeme Emri Rizası Nesnesindeki ÖBHS Masraf Para Birimi verisi ile aynı olmalıdır. | |
| >> Tutar | ttr | N1..18 | Z | ÖBHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır.Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. | Ödeme Emri Rizası Nesnesindeki ÖBHS Masraf Tutarı verisi ile aynı olmalıdır. | |
| > HHS Masraf Tutarı | hhsMsrfTtr | Kompleks:Tutar | İ | |||
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). | Ödeme Emri Rizası Nesnesindeki HHS Masraf Para Birimi verisi ile aynı olmalıdır. | |
| >> Tutar | ttr | N1..18 | Z | HHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. | Ödeme Emri Rizası Nesnesindeki HHS Masraf Tutarı verisi ile aynı olmalıdır. | |
| İşyeri Ödeme Bilgileri | isyOdmBlg | Kompleks:IsyeriOdemeBilgileri | İ | İşyeri ödemelerinde kullanılabilecek alanlardır. Karekodlu işyeri ödemesi akışında bu alanlar dolu geldiği için isteğe bağlı olarak gönderilebilir. isyOdmBlg alanlarının en az birinin dolu olması durumunda istekte yer alır. | ||
| > İşyeri Kategori Kodu | isyKtgKod | AN4 | İ | İşlemin, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). Ödeme Amacı = ‘06’ ya da ‘04’ olan ödeme işlemleri için doldurulabilir. 4 karakterden küçük değerlerin başına 0 eklenerek iletilmesi gereklidir. | ||
| > Alt İşyeri Kategori Kodu | altIsyKtgKod | AN4 | İ | İşlem alt işyerinden gerçekleştiriliyorsa, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). 4 karakterden küçük değerlerin başına 0 eklenerek iletilmesi gereklidir. | ||
| >Üye İş Yeri Tekil Kimlik | genelUyeIsyeriNo | AN8 | İ | İşyeri kayıt sisteminde kayıtlı İşyeri için BKM tarafından üretilmiş olan genel işyeri numarasıdır (GlobalMerchantId) 8 haneden küçük gönderiminde başa ‘0’ eklenmelidir. Örnek değer ‘01630618’ |
BAŞARILI YANIT:
POST işleminin RESPONSE gövdesini (BODY) oluşturan “OdemeEmri” nesnesi Tablo-10’daki parametrelerden oluşur:
Tablo 10: “OdemeEmri” nesnesi
| Alan Adı | JSON Alan Adı | Format: Veri modeli İsmi | Zorunlu / Koşullu / İsteğe bağlı | Açıklama |
|---|---|---|---|---|
| Riza Bilgileri | rzBlg | Kompleks: RizaBilgileri | Z | |
| > Rıza No | rizaNo | AN1..128 | Z | OdemeEmriRızasi nesnesinin oluşturulması esnasında HHS kaynak sunucusu tarafından atanan biricik tanımlayıcı |
| > Oluşturma Zamanı | olusZmn | ISODateTime | Z | OdemeEmriRizasi nesnesinin oluşturulma zamanı |
| > Rıza Durumu | rizaDrm | AN1 | Z | TR.OHVPS.DataCode.RizaDurumu sıralı veri tipini değerlerinden birini alır. |
| Katılımcı Bilgisi | katilimciBlg | Kompleks:KatilimciBilgisi | Z | Katılımcılara atanmış kod bilgileridir. |
| >Hesap Hizmeti Sağlayıcısı Kodu | hhsKod | AN4 | Z | İsteğin iletildiği Hesap Hizmeti Sağlayıcısının kodudur. (Nezdinde ÖH bulunduran kuruluş kodu. Örneğin, Banka, Elektronik Para Kuruluşu ve Ödeme Kuruluşu) |
| > Yetkili Ödeme Hizmeti Sağlayıcısı Kodu | yosKod | AN4 | Z | İsteği gönderen Yetkili Ödeme Hizmeti Sağlayıcısı (YÖS) kodudur. |
| GKD | gkd | Kompleks:Gkd | Z | |
| > Yetkilendirme Yöntemi | yetYntm | AN1 | Z | TR.OHVPS.DataCode.GkdTur sıralı veri türü değerlerinden birini alır. |
| > Yönlenme Adresi | yonAdr | AN1..1024 | K | Yönlendirmeli güçlü kimlik doğrulama için zorunlu. |
| > Bildirim Adresi | bldAdr | AN1..1024 | K | Ayrık güçlü kimlik doğrulama için zorunlu. |
| > HHS Yönlenme Adresi | hhsYonAdr | AN1..1024 | K | GKD doğrulama bilgilerinin girilebilmesi için uygulamadan açılacak yönlendirme sayfasının adresi |
| > Yetkilendirme Tamamlanma Zamanı | yetTmmZmn | ISODateTime | Z | Yetkilendirme akışının tamamlanması gereken son zamanı gösterir. Rıza durumu Yetkilendirildi statüsüne geçene kadarki süredir. |
| Emir Bilgileri | emrBlg | Kompleks: EmirBilgileri | Z | |
| > Ödeme Emri Numarası | odmEmriNo | AN1..128 | Z | Ödeme Emri nesnesinin UID'sidir. OdemeEmrine İlişkin sorgular bu ID üzerinden yapılır. |
| > Ödeme Emri Zaman | odmEmriZmn | ISODateTime | Z | Ödeme emrinin FAST, PÖS, havale gibi gerçekleştirileceği ilgili ödeme sistemine iletilme tarihi. |
| Ödeme Başlatma | odmBsltm | Kompleks: OdemeBaslatma | Z | |
| > Kimlik | kmlk | Kompleks:Kimlik | Z | |
| >> Kimlik Türü | kmlkTur | AN1 | Z | TR.OHVPS.DataCode.KimlikTur sıralı veri türü değerlerinden birini alır. |
| >> Kimlik Verisi | kmlkVrs | AN1..30 | Z | HHS nezdinde kullanıcı doğrulamasında kullanılan tanımlayıcıdır. TR.OHVPS.DataCode.KimlikTur değerine göre uzunluk ve formatı değişir. |
| >> Kurum Kimlik Türü | krmKmlkTur | AN1 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik türüdür. TR.OHVPS.DataCode.KurumKimlikTur sıralı veri türü değerlerinden birini alır. |
| >> Kurum Kimlik Verisi | krmKmlkVrs | AN1..30 | K | Kurum adına yapılan ödemelerde ÖHK’nın altında tanımlı olduğu tüzel kişilik için kullanılan kurum kimlik verisidir. TR.OHVPS.DataCode.KurumKimlikTur değerine göre uzunluk ve formatı değişir. |
| >> Ödeme Hizmeti Kullanıcısı Türü | ohkTur | AN1 | Z | TR.OHVPS.DataCode.OhkTur sıralı veri türü değerlerinden birini alır (B: Bireysel, K:Kurumsal) |
| > İşlem Tutarı | islTtr | Kompleks:Tutar | Z | |
| >> Para Birimi | prBrm | AN3 | Z | Para Birimi. Karekod akışında, FAST Karekod Veri Organizasyonundaki 53: (Para Birimi) alanında tanımlı Para Birimi verisi kullanılır. |
| >> Tutar | ttr | N1..18 | Z | ÖBHS'nin ön yüzde kullanıcıdan teyit aldığı tutar. Karekod akışında, FAST Karekod Veri Organizasyonundaki 54: (Tutar) alanında tanımlı Tutar verisi kullanılır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. |
| > Gönderen | gon | Kompleks:Hesap | Z | |
| >> Unvan | unv | AN3..140 | Z | Gönderen kişinin ad soyad ya da ticari unvan bilgisi. |
| >> Hesap Numarası | hspNo | AN26 | K | ÖBHS tarafından iletilip doğrulanan veya HHS ekranında seçilen Gönderen Hesap Numarası dönülür. |
| >> Hesap Referansı | hspRef | AN5..40 | K | HHS tarafından hesap için atanan biricik tanımlıyıcıdır (uuid) YÖS bazında farklılaşması gerekmez. ÖBHS’nin aynı zamanda HBHS olduğu durumda müşteri rızası tesis edilmiş bir hesabın referansı üzerinden de ödeme başaltılabilir. GKD sonrası HHS ekranında seçilen Hesap Referansı POST işleminin yanıtında dönülemez ancak isteğe bağlı GET sorgusu ile dönülebilir. Hesap Numarası kullanılıyorsa Hesap Referansı kullanılmayabilir. |
| > Alıcı | alc | Kompleks:Hesap | Z | |
| >> Unvan | unv | AN3..140 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen adres kaydı yaptırmış olan alıcının maskeli ad-soyadı veya maskeli ticari unvan bilgisidir. Kolas’tan dönen “account owner” alanı kullanılmalıdır. Kolay adres değil ise ÖBHS tarafından istek mesajında iletilen unvan bilgisidir. |
| >> Hesap Numarası | hspNo | AN26 | Z | Alıcının Hesap Numarası alanıdır (IBAN). Kolay Adres sorgusunda dönülen adres kaydı yaptırmış olan alıcının maskeli IBAN bilgisidir. Kolay adres değil ise ÖBHS tarafından istek mesajında iletilen IBAN bilgisidir. Karekod akışında, FAST Karekod Veri Organizasyonundaki 30-01: alanında tanımlı İş Yeri IBAN verisi kullanılır. |
| >> Kolay Adres | kolas | Kompleks:Kolas | K | |
| >>> Kolas Türü | kolasTur | AN1 | Z | Müşterinin sorgulamak istediği Kolay Adres Tipi değeridir. TR.OHVPS.DataCode.KolasTur sıralı veri türü değerlerinden birini alır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. |
| >>> Kolas Değeri | kolasDgr | AN7..50 | Z | Müşterinin eklediği, HHS (FAST katılımcısı) tarafından doğrulanmış Kolay Adres değeridir. Alabileceği değerler BKM “Kolay Adresleme Sistemi Uygulama Kuralları” belgesinde tanımlıdır. Alıcı Hesap Numarası girilmediyse kullanımı zorunludur ve Kolay Adres Tipi alanıyla birlikte kullanılır. |
| >>> Kolas Referans Numarası | kolasRefNo | N12 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen, BKM Kolay Adresleme Sistemi Uygulama Kuralları’nda tanımlı KOLAS tarafından ilgili sorguya özel olarak üretilmiş referans numarasıdır. |
| >>> Kolas Hesap Türü | kolasHspTur | AN1 | Z | Kolay Adres Alıcı Sorgusunda başarılı sorgu sonucunda dönülen, BKM Kolay Adresleme Sistemi Uygulama Kuralları’nda tanımlı hesap türü bilgisidir: TR.OHVPS.DataCode.KolasHspTur sıralı veri değerlerinden birini alır. |
| > Karekod | kkod | Kompleks:Karekod | K | |
| >> Akış Türü | aksTur | AN2 | Z | Karekod Akış Türü Karekod ödemesinin hangi akışla gerçekleştirildiğini gösterir. Kolay Adresi Sistemi ile birlikte kullanılmaz. 01: FAST katılımcısından dinamik doğrulama hizmeti alınan işyeri ödemesi 02: FAST katılımcısından statik doğrulama hizmeti alınan işyeri ödemesi 03: Kişiden kişiye ödemeler |
| >> Referansı | kkodRef | AN1..12 | K | Karekod referans numarasını gösterir. Okunan karekodda referans değeri varsa kullanılması zorunludur. Kolay Adresi Sistemi ile birlikte kullanılmaz. |
| >> Üretici Kodu | kkodUrtcKod | AN4 | Z | Karekod üreticisinin kodu. Ödeme Hizmeti Sağlayıcıları ve TCMB tarafından uygun görülen ödeme sistemi işleticisi TR Karekod üretebilmek için BKM’ye kayıt başvurusu yaparak karekod üretici kodu alabileceklerdir. Bankalar EFT kodlarını kullanacak olup ayrıca kayıt yaptırmalarına gerek bulunmamaktadır. 4 haneden kısa değerlerin sol tarafı ’0’ karakteri ile tamamlanmalıdır. |
| > Ödeme Ayrıntıları | odmAyr | Kompleks: OdemeAyrintilari | Z | |
| >> Ödeme Kaynağı | odmKynk | AN1 | Z | Ödemenin başlatıldığı kaynağı belirtir. TR.OHVPS.DataCode.OdemeKaynak sıralı veri değerlerinden birini alır. |
| >> Ödeme Durumu | odmDrm | AN2 | Z | TR.OHVPS.DataCode.OdemeDurumu sıralı veri değerlerinden birini alır. |
| >> Ödeme Amacı | odmAmc | AN2 | Z | TR.OHVPS.DataCode.OdemeAmaci sıralı veri değerlerinden birini alır. |
| >> Referans Bilgisi | refBlg | AN1..140 | K | Ödemeye özel Referans Bilgisi alanıdır. Karekod işlemi değil ise zorunludur. - Kişiden kişiye fon aktarımlarda: Gün içerisinde ÖHK için biricik olarak oluşturan referans bilgisi - E-ticaret işlemlerinde sipariş/takip numarası/müşteri/abone numarası - Karekod akışında, FAST Karekod Veri Organizasyonundaki - 62-01: alanında tanımlı Fatura Numarası - 62-06: alanında tanımlı Müşteri Numarası verilerinden biri kullanılır. |
| >> Açıklama | odmAcklm | AN1..50 | İ | ÖBHS’nin ÖHK’dan aldığı ya da kendisinin atadığı işlem açıklaması bilgisi. |
| >> ÖHK Mesaj Alanı | ohkMsj | AN1..200 | İ | HHS’nin ÖHK’ya göstermek üzere ilettiği mesaj. |
| >> Ödeme Sistemi | odmStm | AN1 | Z | TR.OHVPS.DataCode.OdemeSistemi sıralı veri değerlerinden birini alır. |
| >> Ödeme Sistem Numarası | odmStmNo | AN10..50 | K | Ödeme başarılı başlatıldıysa, ödemenin başlatıldığı sistemdeki referans numarası. FAST işlemleri için MesRefBlg değeri atanır. Ödeme Hizmeti kullancısına işlemin takibi için gösterilebilir. |
| >> Beklenen Ödeme Zamanı | bekOdmZmn | ISODateTime | K | İşlemin yönlendirildiği ödeme sistemi PÖS ise ve PÖS işlem saatleri dışında ise işlemin yapılabileceği ilk zaman bilgisi |
| > ÖBHS Masraf Tutarı | obhsMsrfTtr | Kompleks:Tutar | İ | |
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). |
| >> Tutar | ttr | N1..18 | Z | ÖBHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır.Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. |
| > HHS Masraf Tutarı | hhsMsrfTtr | Kompleks:Tutar | İ | |
| >> Para Birimi | prBrm | AN3 | Z | Para birimi (TRY, USD, EUR vb.). |
| >> Tutar | ttr | N1..18 | Z | HHS’nin işlemle ilgili ÖHK’nın borçlandırılmasını belirttiği masraf tutarı. İşlem Tutarı ile aynı para biriminde olmalıdır. Örneğin 1,20 TRY için tutar alanında “120” değeri iletilir. |
| İşyeri Ödeme Bilgileri | isyOdmBlg | Kompleks:IsyeriOdemeBilgileri | İ | İşyeri ödemelerinde kullanılabilecek alanlardır. Karekodlu işyeri ödemesi akışında bu alanlar dolu geldiği için isteğe bağlı olarak gönderilebilir. isyOdmBlg alanlarının en az birinin dolu olması durumunda yanıtta yer alır. |
| > İşyeri Kategori Kodu | isyKtgKod | AN4 | İ | İşlemin, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). Ödeme Amacı = ‘06’ ya da ‘04’ olan ödeme işlemleri için doldurulabilir. |
| > Alt İşyeri Kategori Kodu | altIsyKtgKod | AN4 | İ | İşlem alt işyerinden gerçekleştiriliyorsa, ISO 18245:2003 uyumlu İşyeri Kategori Kodudur (Merchant Category Code, MCC). |
| >Üye İş Yeri Tekil Kimlik | genelUyeIsyeriNo | AN8 | İ | İşyeri kayıt sisteminde kayıtlı İşyeri için BKM tarafından üretilmiş olan genel işyeri numarasıdır (GlobalMerchantId) 8 haneden küçük gönderiminde başa ‘0’ eklenmelidir. Örnek değer ‘01630618’ |
# 6.6. ADIM 3.1- Ödeme Emri Sorgusu (İsteğe bağlı)
Şekil 9: Ödeme Emri Sorgusu
# GET /odeme-emri/{odemeEmriNo}
ÖBHS, bu erişim adresi aracılığıyla ödeme emrini sorgulayabilir.
BAŞARILI YANIT:
GET /odeme-emri/{odemeEmriNo} yanıtının (RESPONSE) gövdesinde (BODY) “OdemeEmri” nesnesi bulunur. İstek başarıyla sonuçlanırsa HHS kaynak sunucusunda Tablo-10’da yer alan parametreleri içeren “OdemeEmri” nesnesi döner.
# 6.7 Healthcheck API
# GET /health
HHS’lerin sunacağı bu servis, düzenli olarak BKM tarafından çağırılarak servislerin ayakta olup olmadıklarının kontrolünün sağlanması planlanmaktadır
Başarılı yanıtta Http 200 kodu dönülmelidir.
Başarılı Yanıt:
| Alan Adı | JSON Alan Adı | Format: Veri modeli İsmi | Zorunlu / Koşullu / İsteğe bağlı | Açıklama |
|---|---|---|---|---|
| status | status | AN2..20 | Z | “UP”, “DOWN” değerlerini alabilir |