Para Birimi Bazlı POS Listeleme

• Endpoint: /vpws/paymentOptions
• HTTP Method: GET
• Request Content-Type: application/json
• Response Content-Type: application/json
• Yetkilendirme: Geçerli AccessToken zorunludur.
  (Bkz: 2. Kimlik Doğrulama – AccessToken Alınması)

Açıklama

Bu servis, ilgili AccessToken'a bağlı Bayiye tanımlı ödeme seti içerisindeki POS'ları, belirtilen para birimi (currency) bazında listeler.

Servis çıktısında

• Bayiye tanımlı POS bilgileri
• POS'a ait taksit seçenekleri
• Komisyon oranları
• UI amaçlı görsel alanlar
• Partner ve POS tipi bilgileri döndürülür.

Not: Bu servis yalnızca bayiye tanımlı ve aktif POS'ları döndürür. Firma genel POS'ları listelenmez.

Query Parametreleri

Parametre	Tip	Zorunlu	Açıklama
currency	string	Evet	ISO 4217 para birimi kodu (örn: TRY, USD, EUR)

Örnek İstek

Method: GET
Authorization: Bearer {AccessToken}
URL: https://apiUrl/vpws/paymentOptions?currency=TRY

Header Bilgileri

Header Adı	Zorunlu	Açıklama
Authorization	Evet	Bearer {AccessToken}
Content-Type	Hayır	application/json

Response (Yanıt) Yapısı

Servis, dizi (array) formatında POS listesi döner. Her bir öğe bir POS nesnesini temsil eder.

POS Alanları

Alan	Tip	Açıklama
name	string	POS adı
colorCode	string	UI'da kullanılacak renk kodu
logo	object	Logo bilgileri
commRates	array	Taksit ve komisyon oranları
isVisibleCommRate	boolean	Komisyon oranı UI'da gösterilsin mi
isDefaultPos	boolean	Varsayılan POS mu
posTypeId	int	POS tipi kimliği
partnerId	int	Entegre partner sistem kimliği

Logo Alanları (logo)

Alan	Tip	Açıklama
id	string (GUID)	Logo kimliği
colorCode	string	Logo zemin rengi
isDefault	boolean	Varsayılan logo
logoSmall	string	Küçük boyut logo yolu
logoMedium	string/null	Orta boy logo
logoBig	string/null	Büyük boy logo
installmentCellColor	string	Taksit hücre arka plan rengi

Taksit / Komisyon Alanları (commRates[])

Alan	Tip	Açıklama
installment	int	Taksit sayısı
commApplyTypeId	int	Komisyon uygulama tipi ID
processCommRate	number	Komisyon oranı (%)
plusInstallment	int	Kampanya/ek taksit sayısı
paymentDeferral	int	Erteleme süresi (gün/ay – sistem tanımına göre)

Örnek Response

[
  {
    "name": "Param Axess 10738",
    "colorCode": "#FCAA0F",
    "logo": {
      "id": "e494c327-4425-ed11-98e1-005056b0d2e5",
      "colorCode": "#ffffff",
      "isDefault": true,
      "logoSmall": "~/Content/themes/base/images/apilogo/akbank/axess.png",
      "logoMedium": null,
      "logoBig": null,
      "installmentCellColor": "#fcffcd"
    },
    "commRates": [
      {
        "installment": 1,
        "commApplyTypeId": 10,
        "processCommRate": 0.0000,
        "plusInstallment": 0,
        "paymentDeferral": 0
      },
      {
        "installment": 2,
        "commApplyTypeId": 10,
        "processCommRate": 3.0000,
        "plusInstallment": 0,
        "paymentDeferral": 0
      }
    ],
    "isVisibleCommRate": false,
    "isDefaultPos": false,
    "posTypeId": 20,
    "partnerId": 1200
  }
]

Örnek cURL

curl --location 'https://pgw.netahsilatdemo.com/vpws/paymentOptions?currency=TRY' \
--header 'Authorization: Bearer {AccessToken}'

Notlar & En İyi Uygulamalar

• currency parametresi zorunludur; gönderilmezse 400 – P001 hatası döner.

• Sadece ilgili bayiye tanımlı aktif POS'lar listelenir.

• commRates boş dönebilir; bu durum POS'un yalnızca tek çekim desteklediğini gösterebilir.

• isVisibleCommRate=false ise oranlar UI'da gizlenebilir; API yine de oranları dönebilir.

• partnerId alanı, işlemin yönlendirileceği entegrasyon katmanını belirtir.

• posTypeId sistem içi sınıflandırma alanıdır; iş mantığı tarafında kontrol edilmelidir.

• Komisyon hesaplamaları ödeme başlatma aşamasında doğrulanmalıdır.