EFT/Havale ve Kapıda Ödeme

EFT/Havale yöntemi veya Kapıda nakit ödeme seçenekleriyle aldığınız ödemeleri Craftgate üzerinden yönetmek için kullanılır.

URL

APM ile ödeme işlemi için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/apm-payments

Ödeme Başlatma İsteği Parametreleri

Parametre Adı Tipi Zorunlu Açıklama
apmType string Evet bkz: Direkt Alternatif Ödeme Yöntemleri Ödeme alınmak istenen alternatif ödeme yöntemi
price decimal Evet Toplam ödeme tutarı. Sepetteki ürün/hizmet tutarları toplamının bu tutara eşit olması gerekmektedir
paidPrice decimal Evet Komisyon ve indirim gibi farklar dahil edilerek hesaplanan, tahsil edilecek nihai tutar.
currency Currency Evet bkz: Para Birimleri Ödemenin tahsil edileceği para birimi
paymentGroup PaymentGroup Evet bkz: Ödeme Grupları
paymentChannel string Hayır Genellikle üye işyeri tarafındaki, ödemenin alındığı kanal veya ödemeye özel bir bilgi tutmak için kullanılır. Daha sonradan sorgulama servislerini kullanarak bu değer ile sorgulama yapabilirsiniz.
conversationId string Hayır İstekle beraber gönderilip, cevapla birlikte alınabilecek, "bumerang" değer. Farklı istekleri birbirleriyle ilişkilendirmek için kullanılabilir. Genellikle üye işyerinin ödemeye ilişkin sipariş numarası kullanılır. Sipariş numarası ile kullanmanız sonradan işlemleri incelemenize yardımcı olacaktır.
externalId string Hayır Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri
buyerMemberId number Hayır Ödemenin ilişkilendirildiği alıcı ID'si. Üye işyerinin kendi sistemlerindeki ID değerini değil, Craftgate sistemlerindeki ID değerini ifade eder
apmOrderId string Hayır Ödeme alınırken APM'e iletilecek orderId parametresi. Opsiyonel olduğu için gönderilmemesi ve orderId değerinin Craftgate tarafından üretilmesi önerilir.
clientIp string Hayır Ödeme yapan alıcının IP adresi.
items PaymentItem[] Evet (bkz. Ödeme Kırılım Bilgileri) Ödemeye ilişkin kırılım bilgileri. En az bir kırılım gönderilmesi ve gönderilen kırılımların tutarlarının toplamının price alanına eşit olması zorunludur

Dönüş Parametreleri

APM ile ödeme işleminin sonucunda dönen parametreler API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Açıklama
id number Ödemenin ID'si. Bu değer ödeme isteği için Craftgate tarafından belirlenen eşsiz değerdir. Veritabanınızda sipariş bilgileri ile eşleştirip saklamayı unutmayınız.
createdDate date Ödemenin gerçekleştirildiği tarih
apmType string bkz: Direct Alternatif Ödeme Yöntemleri Ödeme alınmak istenen alternatif ödeme yöntemi
price decimal Ödemenin toplam sepet tutarı
paidPrice decimal Müşterinin ödediği toplam tahsilat tutarı.
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
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
paymentSource PaymentSource bkz: Ödeme Kaynakları
paymentType PaymentType bkz: Ödeme Tipleri
paymentGroup PaymentGroup bkz: Ödeme Grupları
paymentStatus PaymentStatus bkz: Ödeme Durumu
paymentChannel string Üye işyeri tarafından ödeme isteği içerisinde gönderilen paymentChannel değeri
orderId string Ödemeye ilişkin banka tarafından verilen orderId değeri
paymentTransactions PaymentTransaction[] bkz: Ödeme Kırılımı Dönüş Bilgileri

Ödeme Kırılımı Dönüş 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önderimi bilgilerini 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ı
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: Kırılım Onay Durumları) Kırılıma ilişkin onay 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, satıcı ve Craftgate 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.