Ödeme Arama

Geçmişte yapılmış başarılı ya da başarısız tüm ödemeler Craftgate API kullanılarak sorgulanabilir.

URL

Ödeme sorgulamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
GET /payment-reporting/v1/payments

İstek Parametreleri

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

Parametre Adı Tipi Zorunlu Açıklama
paymentId number Hayır Ödemenin id bilgisi
paymentTransactionId number Hayır Ödeme kırılımının id bilgisi
buyerMemberId number Hayır Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer
subMerchantMemberId number Hayır Ödeme kırılımının ilişkili olduğu satıcı ID'si
conversationId string Hayır Üye işyeri tarafından ödeme isteği içerisinde gönderilen conversationId değeri
externalId string Hayır Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri
merchantPosId number Hayır Ödemenin geçtiği posun id bilgisi
orderId string Hayır Ödemeye ilişkin banka tarafından verilen orderId değeri
paymentType PaymentType Hayır bkz: Ödeme Tipleri
paymentStatus PaymentStatus Hayır bkz: Ödeme Durumu
binNumber string Hayır Ödeme yapılan kartın ilk 6 hanesini belirtir
lastFourDigits string Hayır Ödeme yapılan kartın son 4 hanesini belirtir
currency Currency Hayır bkz: Para Birimleri Ödemenin tahsil edildiği para birimi
minPaidPrice decimal Hayır Ödemede tahsil edilmiş minimum tutar bilgisi
maxPaidPrice decimal Hayır Ödemede tahsil edilmiş maksimum tutar bilgisi
installment number Hayır Ödemenin taksit sayısı
isThreeDS boolean Hayır Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği
minCreatedDate date Hayır Ödemenin geçirildiği minimum tarih bilgisi
maxCreatedDate date Hayır Ödemenin geçirildiği maksimum tarih bilgisi
page number Hayır Sayfalama için sayfa sayısı
size number Hayır 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:

Parametre Adı Tipi Açıklama
id number Ödemenin ID'si
createdDate date Ödemenin gerçekleştirildiği tarih
price decimal Ödemenin toplam sepet tutarı
paidPrice decimal Müşterinin ödediği toplam tahsilat tutarı. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir
walletPrice decimal Cüzdandan tahsil edilen tutar
currency string Ödemeye ilişkin para birimi
buyerMemberId number Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer
installment number Ödemenin taksit sayısı.
conversationId string Üye işyeri tarafından ödeme isteği içerisinde gönderilen conversationId değeri
externalId string Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri
paymentType PaymentType bkz: Ödeme Tipleri
paymentGroup PaymentGroup bkz: Ödeme Grupları
paymentStatus PaymentStatus bkz: Ödeme Durumu
paymentPhase PaymentPhase bkz: Ödeme Fazları
isThreeDS boolean Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği
merchantCommissionRate decimal Son kullanıcıya yansıtılan vade farkı oranı
merchantCommissionRateAmount decimal Son kullanıcıya yansıtılan vade farkı tutarı. paidPrice ile price arasındaki farka eşittir
bankCommissionRate string Banka komisyon oranı
bankCommissionRateAmount string Banka komisyon tutarı
paidWithStoredCard boolean Ödemenin saklı kartla gerçekleştirilip gerçekleştirilmediğini belirtir
binNumber string Saklı kartla yapılmayan ve tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın ilk 6 hanesini belirtir
lastFourDigits string Saklı kartla yapılmayan ve tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın son 4 hanesini belirtir
authCode string Ödemeye ilişkin banka tarafından verilen authCode değeri
hostReference string Ödemeye ilişkin banka tarafından verilen hostReference değeri
transId string Ödemeye ilişkin banka tarafından verilen transId değeri
orderId string Ödemeye ilişkin banka tarafından verilen orderId değeri
cardType CardType (bkz: Kart Tipleri) Saklı kartla yapılmayan ve tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın tipini ifade eder
cardAssociation CardAssociation (bkz: Kart Kuruluşları) Saklı kartla yapılmayan ve tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartı sağlayan kart kuruluşuunu ifade eder
cardBrand string Saklı kartla yapılmayan ve tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Ödeme için yapılan istekte kart bilgilerinde yer alan cardBrand ile aynı değeri taşır
cardHolderName string Kart sahibinin adı/soyadı
cardIssuerBankName string Kartın ait olduğu banka
mdStatus string Ödemeye ait bankadan dönülen durum
retryCount string Ödeme alınırken yapılan farklı deneme sayısı
refundablePrice string İade edilebilecek tutar bilgisi
refundStatus PaymentRefundStatus Ödeme iade edilme durum bilgisi bkz: İade Edilme Durumları
pos MerchantPos Ödemenin alındığı pos bilgileri bkz: Ödeme POS Bilgisi
paymentError PaymentError Ödeme hata aldıysa, hataya ait detay bilgileri bkz: Ödeme Hata Bilgisi
refunds ReportingPaymentRefundResponse[] bkz: Ödeme İade Bilgileri

Üye işyeri POS bilgileri

Parametre Adı Tipi Açıklama
id number Üye işyeri POS ID'si
name string Üye işyeri POS adı
alias string Üye işyeri POS alias ı

Ödeme İade Bilgileri

Ödemeye ait iade bilgileri varsa, iadelere ait detay bilgileri içerir

Parametre Adı Tipi Açıklama
id number Ödeme iadesinin ID'si
createdDate date İade yapılan tarih ve saat
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
refundDestinationType RefundDestinationType İade karta ise CARD cüzdana ise WALLET girilecek olan alan. Varsayılan değer CARD bknz. İade Tipleri
refundPrice decimal İade edilen tutar
refundBankPrice decimal İade edilen banka tutarı
refundWalletPrice decimal İade edilen cüzdan tutarı
conversationId string İadeye ait 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 ait transId değeri
paymentType PaymentType bkz: Ödeme Tipleri
error PaymentError Ödeme bkz: Ödeme Hata Bilgisi

Örnek Kodlar

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