Ödəniş Bölgüsünün Təsdiqi

URL

Ödənişi bölgüsünü təsdiq etmək üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:

HTTP Metod URL
POST /payment/v1/payment-transactions/approve

Sorğu Parametrləri

Ödəniş bölgüsünün təsdiqini vermək üçün sorğularda göndərilməsi gözlənilən parametrlər aşağıdakı cədvəl və alt başlıqlar altında sadalanmışdır.

Parametrin Adı Növü Məcburi Açıqlama
paymentTransactionIds number[] Bəli Təsdiqinin verilməsi tələb olunan ödəniş bölgülərinin ID dəyərlərini ehtiva edir
isTransactional boolean Xeyr Təsdiq əməliyyatı zamanı hər hansı ödəniş bölgüsü prosedur səbəblərindən təsdiq edilmədikdə bu dəyər true olduqda heç bir ödəniş bölgüsü təsdiq edilmir. Bu dəyər false olduqda təsdiqlənə bilən ödəniş bölgüləri təsdiqlənir, təsdiq edilməyənlər isə təsdiq edilməmiş vəziyyətdə qalır.

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
size number Bəli Təsdiq əməliyyatının nəticəsində təsirə məruz qalan ödəniş bölgüsü sayı
items PaymentTransactionApproval[] Bəli Təsdiq əməliyyatına dair məlumatları daşıyan obyekt baxın: Ödəniş Bölgüsünün Təsdiq Məlumatları
paymentTransactions PaymentTransaction[] Bəli bax: Ödəniş Bölgüsünün Təsdiq Məlumatları

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

Ödəniş bölgüsü təsdiq və təsdiqin geri çəkilməsi sorğusu zamanı qayıdan obyekt daxilində həyata keçirilən əməliyyata və ödəniş bölgüsünə dair məlumatları özündə birləşdirən obyektdir.

Parametrin Adı Növü Hər zaman Mövcuddur Açıqlama
paymentTransactionId long Bəli Ödəniş bölgüsünün ID-si
approvalStatus string Bəli Ödəniş bölgüsünün nəticəsi uğurlu olduqda SUCCESS uğursuz olduqda isə FAILURE dəyərini əks etdirir
failedReason string Bəli Ödəniş bölgüsü təsdiq və ya təsdiqin geri çəkilməsi nəticəsində xətalı olduqda xətanın təfərrüatlarına dair məlumatı əks etdirir

Ödəniş Bölgüsünün Təsdiqinin Geri Alınması

URL

Ödəniş bölgüsünün təsdiqini geri almaq üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:

HTTP Method URL
POST /payment/v1/payment-transactions/disapprove

Sorğu Parametrləri

Ödəniş bölgüsünün təsdiqini geri almaq üçün sorğularda göndərilməsi gözlənilən parametrlər aşağıdakı cədvəl və alt başlıqlar altında sadalanmışdır.

Parametrin Adı Növü Məcburi Açıqlama
paymentTransactionIds number[] Bəli Bu, əvvəllər verilmiş təsdiqi ləğv etmək istəyən ödəniş bölgülərinin ID dəyərlərini ehtiva edir.
isTransactional boolean Xeyr Təsdiq əməliyyatı zamanı hər hansı ödəniş bölgüsü prosedur səbəblərindən geri çəkilmədikdə bu dəyər true olduqda heç bir ödəniş bölgüsünün təsdiqi geri çəkilmir. Bu dəyər false olduqda təsdiqi geri çəkilə bilən ödəniş bölgülərinin təsdiqləri geri alınır, təsdiq edilməyənlər isə təsdiq edilməmiş vəziyyətdə qalır.

Qayıdış Parametrləri

Ödəniş 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
size number Bəli Təsdiq əməliyyatının nəticəsində təsirə məruz qalan ödəniş bölgüsü sayı
items PaymentTransactionApproval[] Bəli Təsdiq əməluyyatına dair məlumatları daşıyan obyekt baxın: Ödəniş Bölgüsünün Təsdiq Məlumatları
paymentTransactions PaymentTransaction[] Bəli bax: Ödəniş Bölgüsünün Təsdiq Məlumatları

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

Ödəniş bölgüsü təsdiq və təsdiqin geri çəkilməsi sorğusu zamanı qayıdan obyekt daxilində həyata keçirilən əməliyyata və ödəniş bölgüsünə dair məlumatları özündə birləşdirən obyektdir.

Parametrin Adı Növü Hər zaman Mövcuddur Açıqlama
paymentTransactionId long Bəli Ödəniş bölgüsünün ID-si
approvalStatus string Bəli Ödəniş bölgüsünün nəticəsi uğurlu olduqda SUCCESS uğursuz olduqda isə FAILURE dəyərini əks etdirir
failedReason string Bəli Ödəniş bölgüsü təsdiq və ya təsdiqin geri çəkilməsi nəticəsində xətalı olduqda xətanın təfərrüatlarına dair məlumatı əks etdirir

Ödəniş Bölgüsünün Yenilənməsi

Məhsul ödənişlərində, satıcının dəyişməsi və ya satıcı (alt üzv biznes) qiymətində dəyişiklik kimi səbəblərdən istəsəniz, alt üzv biznesi və/və ya alt üzv biznesinin qiymətini yeniləyə bilərsiniz. Xidmətdən istifadə etmək üçün siz Satış platforması tipli biznes olmalı və ödənişli məhsul növünə malik olmalısınız.

Diqqət tələb edən məqamlar

  • Bu servisdən yalnız satış platformaları tərəfindən istifadə edilə bilər.
  • Bu servis yalnız uğurlu ödənişlər üçün istifadə edilə bilər.
  • Ödəniş qrupu, məhsul olan ödəniş bölgüləri yenilənə bilər.
  • Ödəniş bölgüsünün pul göndərmə statusu PAYOUT_STARTED(göndərilir) və ya PAYOUT_COMPLETED(göndərildi) olduqda servisdən istifadə etmək olmaz.
  • Servisdən istifadə zamanı alt üzv biznes və ya alt üzv biznesin qiymətindən ən azı biri dəyişməlidir.
  • Ödəniş və ödəniş bölgüsü daha əvvəl ləğv edilməmiş/qaytarılmamış olmalıdır.
  • Ödəniş bölgüsü üçün istədiyiniz qədər yeniləmə həyata keçirə bilərsiniz.
  • Alt üzv biznesin qiyməti ödəniş bölgüsünün qiymətindən yüksək olmamalıdır.
  • Ödəmə bölgüsünün emal vəziyyəti təsdiqi gözləyən vəziyyətdə olmalıdır.

URL

Ödənişi bölgüsünü yeniləmək üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:

HTTP Metod URL URL Parametreleri
PUT /payment/v1/payment-transactions/:id id: Ödəniş bölgüsünün ID dəyəri

Sorğu Parametrləri

Ödəniş bölgüsünün təsdiqini geri almaq üçün sorğularda göndərilməsi gözlənilən parametrlər aşağıdakı cədvəl və alt başlıqlar altında sadalanmışdır.

Parametrin Adı Növü Məcburi Açıqlama
subMerchantId number Bəli Alt üzv biznesin ID-si
subMerchantPrice decimal Bəli Alt üzv biznesin qiyməti

Qayıdış Parametrləri

Ödəniş bölgüsünü yeniləmə 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
id long Bəli Ödəniş bölgüsünün ID-si
name string Xeyr Ödəniş sorğusunda göndərilən, ödəniş bölgüsü ilə bağlı ad
externalId string Xeyr Ödəniş sorğusunda göndərilən, ödəniş bölgüsü ilə bağlı xarici ID dəyəri
transactionStatus TransactionStatus Bəli (baxın: Pulun Göndərilməsinin Statusları) Bölgü ilə əlaqədar pulun göndərilmə statusunu ifadə edən qiymət
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 bölgüyə düşən payı
walletPrice decimal Bəli Ödəniş üçün pul kisəsindən tutulan cəmi məbləğin müvafiq bölgüyə 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 biznes ID-si
subMerchantPrice decimal Bəli Ödəniş bölgüsünün alt üzv bizneslə əlaqəli olduğu halda yer alır. Ö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 alda yer tutur. Ödənişlə əlaqədar alt üzv biznesə göndəriləcək pulun, üzv biznesə göndəriləcək pula olan nisbətdir
subMerchantPayoutAmount decimal Bəli Ödəniş bölgüsünün alt üzv bizneslə əlaqəli olduğu halda yer tutur. Ödənişlə əlaqədar alt azv 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