Temel Bilgiler
Bu doküman, Finrota Bayi Ödeme Web Servisi (VPWS) REST API servislerini sisteminize entegre ederek bayilere ait ödeme süreçlerinin uçtan uca yönetilmesini sağlamak amacıyla hazırlanmıştır.
VPWS, PWS servisinden farklı olarak ödeme işlemlerinin firma (site sahibi) yerine doğrudan Bayi kimliği altında gerçekleştirilmesini sağlar.
Amaç
Bayilerin
- Kendi ödeme setlerini ve POS oranlarını listelemesi
- Kendi adlarına ödeme başlatması ve tamamlaması
- Gerçekleştirilen işlemlerin detaylarını sorgulaması
- Referans bazlı iptal ve iade işlemlerini yürütmesi
işlemlerini tek bir bütünsel ve güvenli API yapısı üzerinden gerçekleştirmesidir.
Ne İçin Var?
Finrota ödeme altyapısı, bayi bazlı finansal operasyonların merkezi sistem ile entegre şekilde yürütülmesini sağlar.
VPWS aşağıdaki ana işlevleri destekler
- Bayiye tanımlı ödeme setlerini ve POS oranlarını listeleme
- Bayi adına ödeme başlatma (3D'li / 3D'siz)
- İşlem detaylarını ERP uyumlu formatta sorgulama
referenceCodeveyaclientReferenceCodeüzerinden iptal (cancel) ve iade (refund) işlemleri gerçekleştirme
PWS ile Temel Fark
| PWS | VPWS |
|---|---|
| İşlem firma (tenant/site sahibi) adına yapılır | İşlem bayi kimliği altında yapılır |
| ApiKey firma bazlıdır | ApiKey bayi bazlıdır |
agentCode çoğunlukla müşteri kodudur | agentCode bayi kimliği ile ilişkilidir |
| Firma POS tanımları kullanılır | Bayiye tanımlı POS'lar kullanılır |
Nasıl Bağlanıyor?
- Tüm servisler HTTPS/REST protokolü üzerinden çalışır.
- Veri alışverişi JSON formatında, UTF-8 karakter setiyle yapılır.
- Tüm çağrılar TLS 1.2+ ile şifrelenmiş olmalıdır.
Güvenlik
- Bearer Token tabanlı yetkilendirme (AccessToken) zorunludur.
- Her istek geçerli bir AccessToken içermelidir.
- Süresi dolan token ile yapılan çağrılar
401 Unauthorizeddöner. - Bayi bazlı yetkilendirme uygulanır; her token yalnızca ilgili bayiye ait işlemler için geçerlidir.
- Token alma ve yenileme süreci için bkz: 2. Kimlik Doğrulama
Ortamlar
| Ortam | URL | Açıklama |
|---|---|---|
| Demo Ortamı (Sandbox) | Test ve geliştirme ortamı; gerçek finansal işlem yapılmaz. | |
| Canlı Ortam (Production) | Gerçek ödeme işlemlerinin yürütüldüğü ortam. |