Ana içeriğe geç

Ödeme İade Arama

Ödemeye ait iadeleri aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

URL

GET/payment-reporting/v1/refunds

İstek Parametreleri

Ödemeye ait iadeleri arama aşağıdaki parametreler kullanılarak yapılabilir.

id
number

İadenin ID'si

paymentId
number

Ödemenin id bilgisi

buyerMemberId
number

Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer

conversationId
string

Üye işyeri tarafından iade isteği içerisinde gönderilen conversationId değeri

status
Status

Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner İade Durumu

Değerler:
ACTIVE
PASSIVE
currency
Currency

bkz: Para Birimleri Ödemenin tahsil edildiği para birimi

Değerler:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
minPaidPrice
decimal

İade yapılmış minimum tutar bilgisi

maxPaidPrice
decimal

İade yapılmış maksimum tutar bilgisi

minCreatedDate
date

İadenin geçirildiği minimum tarih bilgisi

maxCreatedDate
date

İadenin geçirildiği maksimum tarih bilgisi

page
number

Sayfalama için sayfa sayısı

size
number

Sayfalama için sonuç sayısı

Dönüş Parametreleri

Ödeme işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Dönen cevaptaki obje yapısı aşağıda belirtilmiştir:

id
number

İadenin ID'si

createdDate
date

İade yapılan tarih ve saat

status
RefundStatus

Başarılı iade işlemleri için SUCCESS başarısız iade işlemleri için FAILURE döner

Değerler:
SUCCESS
FAILURE
refundDestinationType
string

İade karta ya da ödeme kaynağına ise PROVIDER cüzdana ise WALLET döner

refundPrice
decimal

İade edilen tutar

refundBankPrice
decimal

İade edilen banka tutarı

refundWalletPrice
decimal

İade edilen cüzdan tutarı

conversationId
string

Üye işyeri tarafından ödeme iade isteği içerisinde gönderilen conversationId değeri

authCode
string

İade edilen ödemeye ilişkin authCode değeri

hostReference
string

İade edilen ödemeye ilişkin hostReference değeri

transId
string

İade edilen ödemeye ilişkin transId değeri

paymentType
PaymentType

Ödeme tipleri

Değerler:
CARD_PAYMENT
DEPOSIT_PAYMENT
WALLET_PAYMENT
CARD_AND_WALLET_PAYMENT
BANK_TRANSFER
APM
error
PaymentError

İade hata aldıysa, hataya ait detay bilgileri bkz: Ödeme Hata Bilgisi

paymentId
number

İadenin yapıldığı ödeme ID değeri

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.

Loading..