URL

Abonelikleri sorgulamak için kullanılan endpoint'ler ve http metodlar bilgisi aşağıda verilmiştir.

HTTP metod URL URL parametreleri Headers İstek Parametreleri
GET /payment/v1/subscription merchantId: merchant ID limit: bir sayfadaki abone sayısı sınırı pageNumber: arama sayfası numarası
GET /payment/v1/subscription/:status status: Abonelik durumu (örnek: /ACTIVE) merchantId: merchant ID limit: bir sayfadaki abone sayısı sınırı pageNumber: arama sayfası numarası
GET /payment/v1/subscription/retrieve-subscription-id/:subscriptionId subscriptionId: Abonelik ID'si merchantId: merchant ID
GET /payment/v1/subscription/retrieve-conversation-id/:conversationId conversationId: Abonelik ödeme sayfası başlatma sırasında oluşturulan değer merchantId: merchant ID

Dönüş Parametreleri

Tekrarlı Ödeme sorgulama işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Her Zaman Mevcut Açıklama
id long Evet Abonelik ID değeri
merchantId long Evet Üye işyerinin ID değeri
cardUserKey string Evet Alıcının kart kullanıcı anahtarı
cardToken string Evet Alıcının kart tokenı
price string Evet Abonelik toplam tutarı
periodType string Evet Abonelik aralığı
description string Evet Abonelik tanımlaması
nochargeDayCount string Evet Deneme Süresi
nextPaymentDate string Evet Abonelik yenileme tarihi
status string Evet Abonelik durum değeri
version string Evet Sürüm
retryCount long Evet Ödeme Çekme Deneme Sayısı
retryDate string Evet Tekrar Deneme Ödeme Tarihi

Kod Örnekleri

Tipik bir REST isteği aşağıdaki gibi gerçekleştirilebilir:

/payment/v1/subscription?pageNumber=1&limit=10

/payment/v1/subscription/ACTIVE?pageNumber=1&limit=10

/payment/v1/subscription/PASSIVE?pageNumber=1&limit=10

/payment/v1/subscription/retrieve-subscription-id/1

/payment/v1/subscription/retrieve-conversation-id/myConversationID_34

Lütfen başlıklarda merchantId alanını eklemeyi unutmayın.