Ödənişin Alınması

URL

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

HTTP Metod URL
POST /payment/v1/card-payments

Ödənişi Başlatma Sorğusunun Parametrləri

Parametrin Adı Növü Məcburi Açıqlama
conversationId string Xeyr Sorğu ilə göndərilə bilən və cavabla qəbul edilə bilən "bumeranq" dəyəri. Müxtəlif sorğuları bir-biri ilə əlaqələndirmək üçün istifadə edilə bilər. Adətən, üzv biznesin ödənişlə əlaqəli sifariş nömrəsi istifadə olunur.
price decimal Bəli Toplam ödəniş məbləği. Səbətdəki məhsul/xidmət məbləğlərinin cəmi bu məbləğə bərabər olmalıdır.
paidPrice decimal Bəli Müştərinin ödəyəcəyi ümumi yığım məbləği, komissiyalar və endirimlər kimi fərqlər daxil edilməklə hesablanır. Pul kisəsindən tam və ya qismən yığılan ödənişlərdə, pul kisəsindən alınacaq məbləğ də bu məbləğə daxildir.
walletPrice decimal Xeyr buyerId parametrində qeyd edilən alıcının pul kisəsindən tutulacaq məbləğ. Qismən və ya tam olaraq pul kisəsindən tutulacaq ödənişlərdə göndərilməsi məcburidir. Tam olaraq kartdan tutulacaq ödənişlərdə və ya buyerId olmadığı halda 0 olaraq göndərilə bilər. (Defolt: 0)
installment integer Bəli Ödənişin alınacağı taksitlərin sayı. Tək ödəniş üçün 1 olaraq göndərilə bilər. Mümkün dəyərlər 1, 2, 3, 6, 9 və 12-dir.
buyerId long Xeyr Ödənişin əlaqələndirildiyi alıcı ID-si. Bu, üzv biznesin öz sistemlərindəki ID dəyərinə deyil, Odero sistemlərində ID dəyərinə aiddir.
currency Currency Bəli baxın: Valyutalar Ödənişin tutulacağı valyuta
paymentGroup PaymentGroup Bəli baxın: Ödəniş Qrupları
paymentPhase PaymentPhase Xeyr baxın: Ödənişin Fazaları
card Card Xeyr (baxın. Kart Məlumatları) Tutulmanın həyata keçiriləcəyi kartın məlumatları. Tam olaraq pul kisəsindən tutulacaq ödənişlərdə (yəni paidPrice-in walletPrice-a bərabər olduğu ödənişlər) göndərilməsi məcburi deyil
posAlias string Xeyr TOKENGATE ödənişləri üçün istifadə olunur, doldurularsa, ödəniş bu pos vasitəsilə həyata keçiriləcək. (baxın: Gateway Ödənişləri)
items PaymentItem[] Bəli (baxın: Ödəniş Bölgüsünün Məlumatları) Ödəniş üçün bölünmə məlumatı. Ən azı bir bölgü göndərilməli və göndərilən qırılmaların məbləğlərinin cəmi price sahəsinə bərabər olmalıdır.

Kart Məlumatları

Tam və ya qismən kartla həyata keçirilən ödənişlərdə kart məlumatları göndərilməlidir. Bu məlumat kredit kartı, debet kartı və ya prepaid kartın məlumatları ola bilər, həmçinin daha əvvəl saxlanılan kartla əlaqəli identifikasiyaedici məlumatlar da ola bilər.

Göndərilən kart məlumatında cardUserKey sahəsi doludursa, Saxlanılan Kartın Məlumatları bölməsindəki sahələr etibarlıdır. Digər hallarda baxın : Kredit Kartı, Debet Kartı ya da Prepaid Kart Məlumatları.

Kredit Kartı, Debet Kartı ya da Prepaid Kart Məlumatları

Parametrin Adı Növü Məcburi Açıqlama
cardHolderName string Bəli Kart sahibinin adı/soyadı
cardNumber string Bəli Kart nömrəsi
expireYear string Bəli Kartın son istifadə tarixin ili
expireMonth string Bəli Kartın son istifadə tarixin ili
cvc string Bəli Kartın təhlükəsizlik kodu
storeCardAfterSuccessPayment boolean Xeyr Ödəniş uğurlu olduqda, kart yadda saxlanılsın (Defolt: false)
cardAlias string Xeyr Uğurlu ödənişdən sonra kart yadda saxlanılsa, karta veriləcək ad

Saxlanılan Kartın Məlumatları

Parametrin Adı Növü Məcburi Açıqlama
cardUserKey string Bəli Saxlanılan kartın açarı
cardToken string Bəli Saxlanılan kartın kodu

Ödəniş Bölgüsünün Məlumatları

Bütün ödənişlərdə 1 və ya 1-dən çox bölgü göndərilməlidir. Göndərilən bölgülərin price sahələrinin cəmi, ödənişin price sahəsindəki dəyərə bərabər olmalıdır.

Parametrin Adı Növü Məcburi Açıqlama
name string Bəli Ödənişin aid olduğu məhsul və ya xidmətin adı
price decimal Bəli Müvafiq məhsul və ya xidmətin səbət məbləği
externalId string Xeyr Müvafiq məhsul və ya xidməti ifadə edən external ID dəyəri. Ümumiyyətlə, bu bölgünün ID dəyəri üzv biznes sistemində istifadə olunur
subMerchantId long Xeyr Məhsul və ya xidməti təmin edən alt üzv biznesin ID-si
subMerchantPrice decimal Xeyr Ödənişdən alt üzv biznesə ayrılacaq məbləğ. subMerchantId sahəsi doludursa göndərilməlidir

Qayıdış Parametrləri

Ödəniş əməliyyatının prosesi nəticəsində qaytarılan parametrlər də API sənədlərinin əsas səhifəsinin Qayıdış Formatları bölməsində göstərilən qaydalara tabedir. Sistematik və ya quruluş bir xəta olmadıqda, data parametrində qaytarılan obyektin alt parametrləri aşağıdakılardır:

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
conversationId string Xeyr Üzv biznes tərəfindən ödəniş sorğusunun tərkibində göndərilən conversationId dəyəri
id long Bəli Ödənişin ID-si
createdDate date Bəli Ödənişin həyata keçirildiyi tarix
price decimal Bəli Ödənişin toplam səbət məbləği
paidPrice decimal Bəli Müştəri tərəfindən ödənilən ümumi yığım məbləği. pul kisəsindən tam və ya qismən yığılan ödənişlərdə, pul kisəsindən alınacaq məbləğ də bu məbləğə daxildir.
walletPrice decimal Bəli Pul kisəsindən tutulan məbləğ
currency string Bəli Ödəniş valyutası
buyerId long Xeyr Alıcı üzvlə əlaqəli ödənişlərdə müvafiq üzvün ID-sini göstərən dəyər
installment integer Bəli Ödənişin alınacağı taksitlərin sayı. Mümkün dəyərlər 1, 2, 3, 6, 9 və 12-dir.
paymentType PaymentType Bəli baxın Ödəniş Növləri
paymentGroup PaymentGroup Bəli baxın Ödəniş Qrupları
paymentStatus PaymentStatus Bəli baxın Ödəniş Statusu
paymentPhase PaymentPhase Bəli baxın Ödənişin Fazaları
isThreeDS boolean Bəli Ödənişin 3D Secure ilə həyata keçirilib-keçirilmədiyi
merchantCommissionRate decimal Bəli Üzv biznes tərəfindən ödənişə tətbiq edilən komissiyanın dərəcəsi
merchantCommissionRateAmount decimal Bəli Üzv biznes tərəfindən ödənişdən alınan cəmi komissiya məbləği. paidPrice ilə price arasındakı fərqə bərabərdir
pfCommissionRateAmount decimal Bəli Odero tərəfindən ödənişdən, ödəniş vasitəçisi olaraq, alınan komissiya məbləği
cardUserKey string Xeyr Sorğu zamanı kart məlumatları sahəsindəki storeCardAfterSuccessPayment sahəsi true göndərilən ödənişlərdə yer alır. Uğurlu ödənişdən sonra qeydə alınan kartın saxlanılan kart açarını ifadə edir. Müştəri ilə əlaqələndirilərək üzv biznes tərəfindən saxlanmalıdır.
cardToken string Xeyr Sorğu zamanı kart məlumatları sahəsindəki storeCardAfterSuccessPayment sahəsi true göndərilən ödənişlərdə yer alır. Uğurlu ödənişdən sonra qeydə alınan kartın saxlanılan kart kodunu ifadə edir. Müştəri ilə əlaqələndirilərək üzv biznes tərəfindən saxlanmalıdır.
paidWithStoredCard boolean Bəli Ödənişi saxlanılan kartla həyata keçirilib-keçirilmədiyini qeyd edir
binNumber string Xeyr Saxlanılan kartla həyata keçirilməyən və tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kartın ilk 6 rəqəmi qeyd edir
lastFourDigits string Xeyr Saxlanılan kartla həyata keçirilməyən və tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kartın son 4 rəqəmini qeyd edir
cardType CardType Xeyr (baxın Kart Növləri) Saxlanılan kartla həyata keçirilməyən və 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 Təşkilatları) Saxlanılan kartla həyata keçirilməyən və tam və ya qismən kartdan tutulan ödənişlərdə yer alır. Kartı təmin edən kart təşkilatını göstərir
cardBrand string Bəli Saxlanılan kartla həyata keçirilməyən və 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 dəyərə malikdir
paymentTransactions PaymentTransaction[] Bəli baxın: Ödəniş Bölgüsünün Çıxış Məlumatları

Ödəniş Bölgüsünün Qayıdış Məlumatları

Buraya ödəniş sorğusu verilərkən göndərilən bölgü məlumatları və bu bölgülərə əsaslanan ödənişin qiymətləri və pul köçürmələri məlumatı daxildir.

Parametrin Adı Növü Hər Zaman Mövcuddur Açıqlama
id long Bəli Ödənişin ID-si
externalId string Xeyr Ödəniş sorğusunda göndərilən, ödəniş bölgüsü ilə əlaqəli external ID dəyəri
name string Bəli Ödəniş sorğusunda göndərilən, ödəniş bölgüsünün ifadə etdiyi məhsul və ya xidmətin adı
transactionStatus TransactionStatus Bəli baxın: Pul köçürmə Statusları) Bölgü üçün pul köçürmə statusunu ifadə edən dəyə
price decimal Bəli Ödənişin toplam səbət məbləği
paidPrice decimal Bəli Müştəri tərəfindən ödənilən ümumi yığım məbləği. pul kisəsindən tam və ya qismən yığılan ödənişlərdə, pul kisəsindən alınacaq məbləğ də bu məbləğə daxildir.
walletPrice decimal Bəli Pul kisəsindən tutulan məbləğ
merchantCommissionRate decimal Bəli Üzv biznes tərəfindən ödənişə tətbiq edilən komissiyanın dərəcəsi
merchantCommissionRateAmount decimal Bəli Üzv biznes tərəfindən ödənişdən alınan cəmi komissiya məbləği. paidPrice ilə price arasındakı fərqə bərabərdir
pfCommissionRateAmount decimal Bəli Odero tərəfindən ödənişdən, ödəniş vasitəçisi olaraq, alınan komissiya məbləği
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ü ilə əlaqəli olan alt üzv biznesin ID-si
subMerchantName string Bəli Ödəniş bölgüsü alt üzv bizneslə əlaqəli olduqda baş verir. Müvafiq üzv biznesin adını ehtiva edir
subMerchantPrice decimal Bəli Ödəniş bölgüsü alt üzv bizneslə əlaqəli olduqda baş verir. Ödəniş məbləğindən alt üzv biznesə ötürüləcək toplam məbləğin müvafiq bölgüyə düşən payıdır
subMerchantPayoutRate decimal Bəli Ödəniş bölgüsü alt üzv bizneslə əlaqəli olduqda baş verir. Ödənişlə əlaqədar 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ü alt üzv bizneslə əlaqəli olduqda baş verir. Ödənişlə əlaqədar alt üzv biznesə göndəriləcək məbləği ifadə edir
blockageResolvedDate date Bəli Pulun göndərilməsi üçün tələb olunan bloklama müddətinin bitəcəyi tarix
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ında paylaşdırılması daxildir

Ödənişin Bölgüsü Pul Göndərmə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