Ödeme Sorgulama

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/v1/card-payments/:id`

İstek Parametreleri

Ödeme sorgulama sadece ödeme id değeri kullanılarak yapılabilir.

Parametre Adı	Tipi	Zorunlu	Açıklama
`id`	`number`	Evet	Sorgulanmak istenen ödeme ID değeri

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`	`Currency`	Ödemeye ilişkin para birimi. bkz: Para Birimleri
`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ı
`paymentSource`	`PaymentSource`	bkz: Ödeme Kaynakları
`paymentStatus`	`PaymentStatus`	bkz: Ödeme Durumu
`paymentPhase`	`PaymentPhase`	bkz: Ödeme Fazları
`paymentChannel`	`string`	Üye işyeri tarafından ödeme isteği içerisinde gönderilen `paymentChannel` değeri
`isThreeDS`	`boolean`	Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği
`merchantCommissionRate`	`decimal`	Üye işyeri tarafından ödemeye uygulanan komisyon oranı
`merchantCommissionRateAmount`	`decimal`	Üye işyeri tarafından ödemeden alınan toplam komisyon tutarı. `paidPrice` ile `price` arasındaki farka eşittir
`bankCommissionRate`	`decimal`	Banka komisyon oranı
`bankCommissionRateAmount`	`decimal`	Banka komisyon tutarı
`paidWithStoredCard`	`boolean`	Ödemenin saklı kartla gerçekleştirilip gerçekleştirilmediğini belirtir
`binNumber`	`string`	Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın ilk 8 hanesini belirtir
`lastFourDigits`	`string`	Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın son 4 hanesini belirtir
`cardHolderName`	`string`	Kart sahibinin adı/soyadı
`bankCardHolderName`	`string`	Bankada kayıtlı olan kart sahibi adı/soyadı
`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) Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartın tipini ifade eder
`cardAssociation`	`CardAssociation`	(bkz: Kart Kuruluşları) Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kartı sağlayan kart kuruluşunu ifade eder
`cardBrand`	`string`	Tamamı ya da bir kısmı karttan tahsil edilen ödemelerde yer alır. Kart ailesini ifade eder
`paymentTransactions`	`PaymentTransaction[]`	bkz: Ödeme Kırılımı Dönüş Bilgileri

Ödeme Kırılım Bilgileri

Ödeme isteği yapılırken gönderilen kırılım bilgileri ile, ödemenin bu kırılımlar bazındaki fiyatlama ve para gönderimleri bilgisi ile, kırılıma ilişkin iade kalemlerini içerir

Parametre Adı	Tipi	Açıklama
`id`	`number`	Ödeme kırılımının ID'si
`externalId`	`string`	Ödeme isteğinde gönderilen, ödeme kırılımına ilişkin dış ID değeri
`name`	`string`	Ödeme isteğinde gönderilen, ödeme kırılımının ifade ettiği ürün ya da hizmetin adı
`price`	`decimal`	Ödeme kırılımının sepetteki tutarı
`paidPrice`	`decimal`	Ödeme için tahsil edilen toplam tutarın, ilgili kırılıma düşen payı
`walletPrice`	`decimal`	Ödeme için cüzdandan tahsil edilen toplam tutarın, ilgili kırılıma düşen payı
`merchantCommissionRate`	`decimal`	Üye işyeri tarafından ödemeye uygulanan komisyon oranı
`merchantCommissionRateAmount`	`decimal`	Üye işyeri tarafından ödemedem alınan komisyon tutarından ödeme kırılımına düşen pay
`merchantPayoutAmount`	`decimal`	Ödemeye ilişkin üye işyerine gönderilecek olan paranın, ilgili kırılıma düşen payı
`subMerchantMemberId`	`number`	Ödeme kırılımının ilişkili olduğu satıcı ID'si
`subMerchantMemberPrice`	`decimal`	Ödeme kırılımının bir satıcılarla ilişkili olduğu durumda yer alır. Ödeme tutarından satıcıya aktarılacak toplam tutarın, ilgili kırılıma düşen payıdır
`subMerchantMemberPayoutRate`	`decimal`	Ödeme kırılımının bir satıcılarla ilişkili olduğu durumda yer alır. Ödemeye ilişkin satıcıya gönderilecek olan paranın, üye işyerine gönderilecek paraya olan oranıdır
`subMerchantMemberPayoutAmount`	`decimal`	Ödeme kırılımının bir satıcılarla ilişkili olduğu durumda yer alır. Ödemeye ilişkin satıcıya gönderilecek olan tutarı ifade eder
`transactionStatus`	`TransactionStatus`	(bkz: Para Gönderimi Durumları) Kırılıma ilişkin para gönderim durumunu ifade eden değer
`blockageResolvedDate`	`date`	Para gönderimi için gereken blokaj süresinin sonlanacağı tarih
`payout`	`Payout`	(bkz: Ödeme Kırılımı Para Gönderim Dağılımı) Ödeme kırılıma ilişkin para gönderim tutarlarının üye işyeri, satıcı ve Craftgate arasındaki dağılımını içerir

Ödeme Kırılımı Para Gönderim Dağılımı

Ödemeye ilişkin olarak yapılacak para gönderiminin, bir kırılım özelindeki payının üye işyeri ve satıcı arasındaki dağılımını içerir.

Para dağıtımının para birimi her zaman TRY'dir.

Parametre Adı	Tipi	Açıklama
`paidPrice`	`decimal`	Ödeme için tahsil edilen toplam tutarın, ilgili kırılıma düşen payı
`parity`	`decimal`	Döviz paritesi, `TRY` ödemeler için 1 olacaktır.
`currency`	`Currency`	bkz: Para Birimleri
`merchantPayoutAmount`	`decimal`	Ödemeye ilişkin üye işyerine gönderilecek olan paranın TL cinsinden değerinin, ilgili kırılıma düşen payı
`subMerchantMemberPayoutAmount`	`decimal`	Ödemeye ilişkin satıcıya gönderilecek olan paranın TL cinsinden değerinin, ilgili kırılıma düşen payı

Örnek Kodlar

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