Ödəniş Sorğusu

Keçmişdə həyata keçirilmiş uğurlu və ya uğursuz ödənişlər üçün Odero API-dən istifadə edərək sorğu göndərilə bilər.

URL

Ödəniş sorğusu üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:

HTTP Metod URL
GET /payment-reporting/v1/payments/:id

Sorğu Parametrləri

Ödənişi sorğusu sadəcə ödənişin ID-sindən istifadə edərək həyata keçirilə bilər.

Parametrin Adı Növü Məcburi Açıqlama
id integer Bəli Sorğu göndərilən ödənişin ID-si

Qayıdış Parametrləri

Ortaq Ödəniş səhifəsi ilə ödəniş əməliyyatının nəticəsində çıxan parametrlər API sənədlərinin giriş səhifəsindəki Qayıdış Formatları bölməsində göstərilən qaydalara uyğun olmalıdır. Sistem və ya quruluş xətası olmadıqda data parametrində çıxan obyektin alt parametrləri aşağıdakı kimidir:

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
id long Bəli Ödənişin ID-si
createdDate date Bəli Ödənişin ilk yaradıldığı tarix
updatedDate date Bəli Ödənişin yenilənmə tarixi
orderId string Bəli Ödənişlə əlaqədar olaraq yaradılan fərqləndirici ID nömrəsi. Tam olaraq pul qabından tutulan ödənişlər üçün Odero tərəfindən, digər hallarda bank tərəfindən yaradılır
price decimal Bəli Ödənişin toplam səbət məbləği
paidPrice decimal Bəli Tutulan cəmi məbləğ
walletPrice decimal Bəli Pul kisəsindən tutulan məbləğ
paymentType PaymentType Bəli baxın: Valyutalar
currency Currency Bəli baxın: Valyutalar
paymentStatus PaymentStatus Bəli baxın: Ödəniş Statusları
conversationId string Xeyr Ödəniş sorğusunda üzv biznes tərəfindən göndərilən conversationId dəyəri
paymentCard PaymentCard Bəli (baxın: Ödənişin Kart və Komissiya haqqı Məlumatları) Ödənişlə əlaqəli kart və komissiya haqqı məlumatları
paymentRefunds PaymentRefund[] Bəli (baxın: Ödənişin Geri Qaytarılmasına dair Məlumatlar) Ödənişlə əlaqəli geri qaytarmaların siyahısı
paymentTransactions PaymentTransaction[] Bəli (baxın: Ödəniş Bölgüsünə dair Məlumatlar) Ödənişdə yer alan bölgülərin detalları

Ödənişin Kart və Komissiya Məlumatları

Tam olaraq pul kisəsindən tutulanlar da daxil olmaqla bütün ödənişlərlə birlikdə göndərilir.

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
cardType CardType Xeyr (baxın: Kart Növləri) Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kartın növünü ifadə edir
cardAssociation CardAssociation Xeyr (baxın: Kart Quruluşları)Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kartın bağlı olduğu qurumu göstərir
cardBrand string Xeyr Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Ödəniş üçün sorğuda kart məlumatlarında yer alan cardBrand ilə eyni qiymətə malikdir
cardHolderName string Xeyr Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kart sahibinin adı və soyadını əks etdirir
binNumber string Xeyr Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kart nömrəsinin ilk 6 rəqəmini əks etdirir
lastFourDigits string Xeyr Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kart nömrəsinin son 4 rəqəmini əks etdirir
installment integer Bəli Ödənişin taksit sayını göstərir. Ala bildiyi qiymətlər: 1, 2, 3, 6, 912
isThreeDS boolean Xeyr Tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Ödənişin 3D Secure ilə həyata keçirilib-keçirilmədiyini göstərir
mdStatus integer Xeyr (baxın: MD Status) 3D Secure ilə həyata keçirilən və tam və ya qismən kartdan tutulan ödənişlərdə yer alır. 3D Secure təsdiq statusunu göstərir
pfCommissionRateAmount decimal Bəli Ödəniş üçün vasitəçi qurum olaraq Odero-nın ödənişdən aldığı komissiyanın məbləği
merchantCommissionRate decimal Bəli Üzv biznes tərəfindən ödənişə tətbiq edilən komissiya dərəcəsi
merchantCommissionRateAmount decimal Bəli Üzv biznes tərəfindən ödənişdən alınan komissiya haqqının cəmi məbləği
error Error Xeyr (baxın: Xəta Məlumatları) Xətalı şəkildə başa çatan ödənişlərdə yer alır. Xəta məlumatlarını ehtiva edir

Ödənişin Ləğvi ilə əlaqəli Məlumatlar

Tam geri qaytarılan ödənişlər haqqında ətraflı məlumatı ehtiva edir. Bu məlumatlara daxil olan parametrlər aşağıdakı cədvəldə sadalanıb:

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
id long Bəli Ləğv əməliyyatının Odero tərəfindən yaradılan ID-si
createdDate date Bəli Ləğv tarixi
refundStatus string Bəli baxın: Geri qaytarma statusları
refundDestinationType RefundDestinationType Bəli baxın: Geri qaytarma növləri
price decimal Bəli Ləğv edilən məbləğ
refundBankPrice decimal Bəli Ləğvdən sonra karta geri yatırılan
refundWalletPrice decimal Ləğv Ləğvdən sonra pul kisəsinə geri yatırılan
conversationId string Bəli Ləğv sorğusunda üzv biznes tərəfindən göndərilən conversationId dəyəri
paymentType PaymentType Bəli (baxın: Ödəniş Növləri) Ləğv edilən ödənişin tutulma növü
error Error Xeyr (baxın: Xəta Məlumatları) Ləğvin uğursuz olduğu halda yer alır. Xəta məlumatlarını ehtiva edir

Ödənişin Bölgüsü ilə əlaqəli Məlumatlar

Buraya ödəniş sorğusu verilərkən göndərilən bölgü məlumatları, bu bölgülər əsasında ödənişin qiymətinin müəyyən edilməsi və pul köçürmələri və qırılma ilə bağlı geri qaytarma maddələri daxildir.

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
id long Evet Ödənişin bölgüsünün ID-si
createdDate date Bəli Ödənişin bölgüsünün yaradıldığı tarix
externalId string Xeyr Ödəniş sorğusunda göndərilən, ödəniş bölgüsü ilə əlaqəli external ID
transactionStatus TransactionStatus Bəli (baxın: Pulun Göndərilmə Statusları) Bölgü ilə əlaqədar pulun göndərilmə statusunu ifadə edən dəyər
transactionStatusDate date Bəli Bölgü ilə əlaqədar pulu göndərmə statusunun dəyişdiyi son tarixi göstərir
price decimal Bəli Ödəniş bölgüsünün səbətdəki məbləği
paidPrice decimal Bəli Ödəniş üçün tutulan cəmi məbləğin müvafiq quruma düşən payı
walletPrice decimal Bəli Ödəniş üçün pul kisəsindən tutulan cəmi məbləğin müvafiq quruma düşən payı
merchantPayoutAmount decimal Bəli Ödənişlə əlaqədar üzv biznesə göndəriləcək pulun müvafiq bölgüyə düşən payı
subMerchantId long Xeyr Ödəniş bölgüsünün əlaqəli olduğu alt üzv biznesin ID-si
subMerchantName string Bəli Ödəniş bölgüsünü alt üzv bizneslə əlaqəli olduğu halda yer tutur. Buraya müvafiq üzv biznesin adı daxildir
subMerchantPrice decimal Bəli Ödəniş bölgüsünü alt üzv bizneslə əlaqəli olduğu halda yer tutur. Ödəniş məbləğindən alt üzv biznesə ötürüləcək cəmi məbləğin müvafiq bölgüyə düşən payıdır
subMerchantPayoutRate decimal Bəli Ödəniş bölgüsünün alt üzv bizneslə əlaqəli olduğu halda yer tutur. Ödənişlə əlaqəli alt üzv biznesə göndəriləcək pulun üzv biznesə göndəriləcək pula olan nisbətidir
subMerchantPayoutAmount decimal Bəli Ödəniş bölgüsünü alt üzv bizneslə əlaqəli olduğu halda yer tutur. Ödənişlə əlaqədar alt üzv biznesə göndəriləcək məbləği ifadə edir
payout Payout Bəli (baxın: Ödəniş Bölgüsü Pul Göndərməsinin Paylanması) Buraya ödəniş bölgüsü ilə əlaqədar pul göndərməsinin məbləğlərinin üzv biznes, alt üzv biznes və Odero arasındakı paylaşdırılması daxildir
paymentTransactionCard PaymentTransactionCard Bəli (baxın: Ödəniş Bölgüsünün Kart və Komissiya haqqı Məlumatları) Buraya ödəniş bölgüsü ilə əlaqəli kart və komissiya haqqı məlumatlar daxildir
paymentTransactionRefunds PaymentTransactionRefund[] Bəli (baxın: Ödənişin Bölgüsü Geri Qaytarma Məlumatları) Ödənişin bölgüsü ilə əlaqədar tam və ya qismən geri qaytarma məlumatlarının siyahısı

Ödənişin Bölgüsünün Kart və Komissiya Məlumatları

Buraya ödənişin bölgüsü ilə əlaqədar kart və komissiya haqqına dair məlumatlar daxildir

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
merchantCommissionRate decimal Bəli Üzv biznes tərəfindən ödənişə tətbiq edilən komissiya dərəcəsi
merchantCommissionRateAmount decimal Bəli Üzv biznes tərəfindən ödənişdən alınan komissiya məbləğindən ödəniş bölgüsünə düşən pay
pfCommissionRateAmount decimal Bəli Ödəniş üçün vasitəçi qurum olaraq Odero-nın ödənişdən aldığı komissiyanın məbləğindən ödəniş bölgüsünə düşən pay

Ödəniş Bölgüsü Pulun Göndərilməsinin Paylanması

Buraya ödənişlə bağlı həyata keçiriləcək pul köçürməsinin payının üzv biznes, alt üzv biznes ve Odero arasında bölüşdürülməsi daxildir.

Para dağıtımının para birimi her zaman AZN-dir, dolayısı ile diğer para birimleri ile yapılan ödemelerde kur farkı oluşacaktır. Bu farklar pfConversionRate ve pfConversionRateAmount alanlarında belirtilmiştir.

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
paidPrice decimal Bəli Ödəniş üçün tutulan cəmi məbləğin müvafiq bölgüyə düşən payı
currency Currency Bəli bax: Valyutalar
merchantPayoutAmount decimal Bəli Ödənişlə əlaqədar üzv biznesə göndəriləcək pulun AZN valyutasındakı dəyərinin müvafiq bölgüyə düşən payı
subMerchantPayoutAmount decimal Bəli Ödənişlə əlaqədar alt üzv biznesə göndəriləcək pulun AZN valyutasındakı dəyərinin müvafiq bölgüyə düşən payı
pfCommissionRateAmount decimal Bəli Ödənişlə əlaqədar Ödəniş vasitəçisi qurumu olaraq Odero-ya göndəriləcək pulun AZN valyutasındakı dəyərinin müvafiq bölgüyə düşən payı
pfConversionRate decimal Bəli AZN-dən fərqli valyuta ilə həyata keçirilən ödənişlərin pul göndərmələrində Odero-nın əsaslandığı məzənnə fərqi. AZN ödənişlərində 0-dır
pfConversionRateAmount decimal Bəli AZN-dən fərqli valyuta ilə həyata keçirilən ödənişlərin pul göndərmələrində Odero-nın aldığı məzənnə fərqi. AZN ödənişlərdə 0-dır

Ödənişin Bölgüsü ilə əlaqəli Geri Qaytarma Məlumatları

Ödəniş bölgüsü ilə əlaqədar tam və ya qismən uğurlu və ya uğursuz geri qaytarma məlumatlarıdır

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
id long Bəli Ləğv əməliyyatının Odero tərəfindən yaradılan ID-si
createdDate date Bəli Ləğv tarixi
refundStatus string Bəli baxın: Geri qaytarma statusları
refundDestinationType RefundDestinationType Bəli baxın: Geri qaytarma növləri
price decimal Bəli Ləğv edilən məbləğ
refundBankPrice decimal Bəli Ləğvdən sonra karta geri yatırılan
refundWalletPrice decimal Ləğv Ləğvdən sonra pul kisəsinə geri yatırılan
conversationId string Bəli Ləğv sorğusunda üzv biznes tərəfindən göndərilən conversationId dəyəri
paymentType PaymentType Bəli (baxın: Ödəniş Növləri) Ləğv edilən ödənişin tutulma növü
isAfterSettlement boolean Bəli Geri qaytarılmanın, bölgünün pul göndərməsindən sonra həyata keçirilib keçirilmədiyi
error Error Xeyr (baxın: Xəta Məlumatları) Ləğvin uğursuz olduğu halda yer alır. Xəta məlumatlarını ehtiva edir

Xəta Məlumatları

Ödənişə geri qaytarma əməliyyatının həyata keçirilməsi zamanı bankdan alınan xəta detalları daxildir. Xətaların errorCodeerrorGroup dəyərləri Xəta Kodları səhifəsində göstərilənlərlə eynidir

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
errorCode string Bəli Müvafiq xəta üçün Odero API tərəfindən təyin edilən errorCode dəyəri
errorGroup string Bəli Xəta qrupu
errorName string Xeyr Bankdan qayıdan xəta adı
errorMessage string Xeyr Bankdan qayıdan xəta mesajı