Ana içeriğe geç

Ödeme Kırılımdan İade Arama

Kırılımdan iadeleri aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

URL

GET/payment-reporting/v1/refund-transactions

İstek Parametreleri

Ödeme arama aşağıdaki parametreler kullanılarak yapılabilir.

id
number

Kırılımdan iadenin ID'si

paymentId
number

Ödemenin id bilgisi

paymentTransactionId
number

Ödeme kırılımının 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 ödeme 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
isAfterSettlement
boolean

Kırılımdan iadenin para gönderimi sonrasında yapılmış olma durumu

minPaidPrice
decimal

Kırılımdan iade yapılmış minimum tutar bilgisi

maxPaidPrice
decimal

Kırılımdan iade yapılmış maksimum tutar bilgisi

minCreatedDate
date

Kırılımdan iadenin geçirildiği minimum tarih bilgisi

maxCreatedDate
date

Kırılımdan iadenin 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

Kırılımdan iadenin ID'si

createdDate
date

Kırılımdan iade yapılan tarih ve saat

status
RefundStatus

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

Değerler:
SUCCESS
FAILURE
refundDestinationType
string

Kırılımdan iade karta ya da ödeme kaynağına ise PROVIDER cüzdana ise WALLET döner.

refundPrice
decimal

Kırılımdan iade edilen tutar

refundBankPrice
decimal

Kırılımdan iade edilen banka tutarı

refundWalletPrice
decimal

Kırılımdan iade edilen cüzdan tutarı

conversationId
string

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

authCode
string

Kırılımdan iade edilen ödemeye ilişkin authCode değeri

hostReference
string

Kırılımdan iade edilen ödemeye ilişkin hostReference değeri

transId
string

Kırılımdan iade edilen ödemeye ilişkin transId değeri

isAfterSettlement
boolean

Kırılımdan iadenin para gönderimi sonrası iade edilip edilmediği bilgisi

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

Kırılımdan iade hata aldıysa, hataya ait detay bilgileri bkz: Ödeme Hata Bilgisi

paymentTransactionId
number

Kırılımdan iadenin yapıldığı ödeme kırılımı ID değeri

Örnek Kodlar

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

Loading..