Skip to main content
Türk bankalarının kart programları (Bonus, Maximum, Axess, World, Paraf, Cardfinans, Wings) müşteriye puan biriktirme sunar. Bu endpoint, kart bazında puan bakiyesi sorgulamak için kullanılır.
Tüm bankalar puan sorgu API’si sunmaz. Şu anda HalkBank VPOS üzerinde aktiftir. Diğer konnektörler için destek genişlemektedir — güncel matris için konsoldaki Konnektörler ekranına bakın.

Endpoint

POST /api/v1/payments/{transaction_id}/point-inquiry
Mevcut bir ödeme/3DS init kaydına bağlı kart için puan sorgular. Genellikle 3DS init sonrası, otorizasyon öncesi çağrılır — müşteriye “X puanınız var, kullanmak ister misiniz?” akışı için.

İstek

curl -X POST https://vpos.payven.com.tr/api/v1/payments/8e3f5c12-9a7b-4c8d-bc4e-2c963f66afa6/point-inquiry \
  -H "Authorization: Bearer $PAYVEN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "extra_properties": {}
  }'
AlanTipAçıklama
extra_propertiesobjectKonnektör-spesifik ek alanlar (genelde boş)

Yanıt

{
  "transaction_id": "8e3f5c12-9a7b-4c8d-bc4e-2c963f66afa6",
  "status":         "three_d_secure_init_processing",
  "extra_properties": {
    "processed_at":      "2026-05-03T12:34:57.123+00:00",
    "point_balance":     "12500",
    "point_program":     "Bonus",
    "point_currency":    "TRY",
    "max_usable_points": "12500"
  }
}
Yanıttaki status alanı mevcut Transaction durumunu yansıtır (PointInquiry handler’ı durumu değiştirmez). Tipik akışta bu sorgu 3DS init sonrası yapılır, dolayısıyla three_d_secure_init_processing görürsünüz. Direkt sorgu (3DS olmadan) yapıldıysa processing veya authorized olabilir.
extra_properties alanıAçıklama
point_balanceMevcut puan bakiyesi (kuruş cinsinden TRY karşılığı)
point_programBanka programı (Bonus, Maximum, Axess, World, Paraf, vb.)
point_currencyBirim (genellikle TRY)
max_usable_pointsBu işlemde kullanılabilecek maksimum puan
Konnektöre göre alan isimleri değişebilir — point_balance her konnektörde garanti değildir. Yanıt schema’sını extra_properties altındaki gerçek anahtarlarla çalışın; gelmeyen alanları boş varsayın.

Puan kullanarak ödeme

Şu an puan kullanımı konnektöre özgü bir akıştır — CreatePaymentRequest.extra_properties ile aktarılır:
{
  "amount":         { "amount": 15000, "currency": "TRY" },
  "installment":    1,
  "card":           { ... },
  "extra_properties": {
    "use_points":   "5000"
  }
}
Banka talebi onaylarsa kalan tutar (10.000 kuruş) karttan çekilir, 5.000 puan düşülür. Top-level standart bir use_points alanı yol haritasındadır.

Hata response’ları

Hata yanıtı RFC 9457 problem+json formatındadır:
HTTPcodeAnlam
404payment_not_foundİşlem bulunamadı
422point_inquiry_not_supportedBu konnektör puan sorgusu desteklemiyor
422point_inquiry_failedBanka puan sorgusunu reddetti
502point_inquiry_exceptionSorgu sırasında konnektör tarafında beklenmeyen hata

Konnektör desteği matrisi

KonnektörPoint InquiryNotlar
HalkBank VPOSParaf programı
NestPay (genel)⚠️ Konfigürasyon-bağlıBanka anlaşmasına göre
Diğer konnektörlerYol haritasında