URL

Abunələri axtarmaq üçün istifadə edilən endpoint və http metodları barədə məlumat aşağıda verilmişdir:

HTTP metod URL URL parametrləri Headers Sorğu Parametrləri
GET /payment/v1/subscription merchantId: tacir Id-si limit: bir səhifədəki abunə sayının limiti pageNumber: axtarışın səhifə nömrəsi
GET /payment/v1/subscription/:status status: Abunənin statusu (nümunə: /ACTIVE) merchantId: tacir Id-si limit: bir səhifədəki abunə sayının limiti pageNumber: axtarışın səhifə nömrəsi
GET /payment/v1/subscription/retrieve-subscription-id/:subscriptionId subscriptionId: Abunənin Id-si merchantId: tacir Id-si
GET /payment/v1/subscription/retrieve-conversation-id/:conversationId conversationId: Abunə ödənişi səhifəsinin başlanğıcında yaradılan dəyər merchantId: tacir Id-si

Qaytarılma parametrləri

Abunəlik sorğusunun nəticəsində qaytarılan parametrlə Qayıdış Formatları səhifəsinin qayıdış qaydalarına əsaslanır. Sistematik və ya struktural səhv yoxdursa, aşağıdakı qayıdış edilən obyektin data parametrləri ilə gəlir:

Parametrin adı Növü Həmişə mövcuddur İzahat
id long Bəli Abunənin ID dəyəri
merchantId long Bəli Tacirin ID dəyəri
cardUserKey string Bəli Kart istifadəçinin açarı
cardToken string Bəli Kartın Tokenı
price string Bəli Abunənin ümumi məbləği
periodType string Bəli Abunənin müddəti
description string Bəli Abunənin təsviri
nochargeDayCount string Bəli Sınaq müddəti
nextPaymentDate string Bəli Növbəti ödəniş tarixi
status long Bəli Abunənin statusu
version string Bəli Versiya
retryCount long Bəli Ödəniş çıxarma cəhdi sayı
retryDate string Bəli Təkrar ödəmə cəhdi tarixi

Kod nümunələri

Tipik bir REST sorğusu aşağıdakı kimi həyata keçirilə bilər:

/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

merchantId sahəsini headerlarda əlavə etməyi unutmayın.