Tək qeyd endpointi
GET /payment/v1/refund-transactions/{refundTxId}-dir. Bundan əlavə,GET /payment/v1/refund-transactionsiləpaymentId,conversationIdvəpaymentTransactionIdfiltrlərindən istifadə etməklə kolleksiya axtarıla bilər.
URL
Ödənişin geri qaytarılmasını araşdırmaq üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:
| HTTP Metod | URL |
|---|---|
GET |
/payment/v1/refund-transactions/{refundTxId} |
Sorğu Parametrləri
Həyata keçirilmiş geri qaytarma əməliyyatını araşdırmaq üçü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 |
|---|---|---|---|
paymentId |
number | Bəli | Geri qaytarılması tələb olunan ödənişin ID-si |
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. |
refundDestinationType |
string | Xeyr | Geri qaytarma karta həyata keçirildikdə CARD pul kisəsinə həyata keçirildikdə isə WALLET sahəsinə daxil edilir. Defolt dəyər CARD |
Qayıtma Parametrləri
| Parametrin Adı | Növü | Açıqlama |
|---|---|---|
id |
number |
Geri qaytarma əməliyyatına dair yaradılan geri qaytarma ID-si |
conversationId |
string |
Sorğu ilə birlikdə göndərilən conversationId dəyəri |
createdDate |
date |
Geri qaytarılan tarix və saat |
refundStatus |
string |
Uğurlu geri qaytarma əməliyyatları üçün SUCCESS uğursuz geri qaytarma əməliyyatları üçün FAILURE qayıdır |
refundPrice |
decimal |
Geri qaytarılan məbləğ |
refundBankPrice |
decimal |
Geri qaytarılan bank məbləği |
refundWalletPrice |
decimal |
Geri qaytarılan pul kisəsi məbləği |
refundDestinationType |
string |
Ləğv edilən pul kisəsi məbləği |
currency |
string |
Geri qaytarılan məbləğin valyutası |
paymentId |
number |
Geri qaytarılan ödənişin ID-si |
currency |
string |
Geri qaytarılan məbləğin valyutası |
paymentTransactionRefunds |
PaymentTransactionRefundResponse[] |
Geri qaytarma ilə əlaqəli bölgü məlumatlarını özündə birləşdirən obyekt geri qaytarmanın bölgü məlumatları |
Geri Qaytarma Bölgüsünün Məlumatları
Həyata keçirilən geri qaytarmanın bölgüləri ilə bağlı məlumatlardan ibarət obyektdir.
| Parametrin Adı | Növü | Açıqlama |
|---|---|---|
id |
number |
Geri qaytarma əməliyyatının alt bölgüsünə dair yaradılan geri qaytarma ID-si |
conversationId |
string |
Sorğu ilə birlikdə göndərilən conversationId dəyəri |
createdDate |
date |
Geri qaytarılan tarix və saat |
status |
string |
Uğurlu geri qaytarma əməliyyatları üçün SUCCESS uğursuz geri qaytarma əməliyyatları üçün FAILURE qayıdır |
isAfterSettlement |
boolean |
Qaytarılan bölgünün qiyməti geri qaytarma əməliyyatı pulun göndərilməsindən sonra həyata keçirildikdə true pulun göndərilməsindən əvvəl həyata keçirildikdə false olur. |
refundPrice |
decimal |
Bölgü ilə əlaqədar qaytarılan məbləğ |
refundBankPrice |
decimal |
Bölgü ilə əlaqədar geri qaytarılan bank məbləği |
refundWalletPrice |
decimal |
Bölgü ilə əlaqədar geri qaytarılan pul kisəsi məbləği |
currency |
string |
Qaytarılan məbləğin valyutası |
paymentTransactionId |
number |
Qaytarılan ödənişin bölgüsünə aid ID |
paymentId |
number |
Geri qaytarılan ödənişə aid ID |
currency |
string |
Geri qaytarılan məbləğin valyutası |
refundDestinationType |
string |
Geri qaytarma karta həyata keçirildikdə CARD pul kisəsinə həyata keçirildikdə isə WALLET daxil ediləcək sahə. Default dəyər CARD |
Nümunəvi Kodlar
Açıq mənbə kodlu Odero API client-lərindəki nümunəvi kodları nəzərdən keçirə bilərsiniz
- .NET: https://github.com/TokenPayEng/tokenpay-dotnet-client/blob/master/Samples/PaymentSample.cs
- PHP: https://github.com/TokenPayEng/tokenpay-php-client/blob/master/samples/retrieve_payment_transaction_refund.php
- Java: https://github.com/TokenPayEng/tokenpay-java-client/blob/master/src/test/java/tr/com/tokenpay/sample/PaymentSample.java
- Node.js: https://github.com/TokenPayEng/tokenpay-node-client/blob/master/samples/payment/RetrievePaymentTransactionRefund.js