Ana içeriğe geç

Kredi Başvurusu Başlatma

URL

Alışveriş kredisi başvuru başlatma için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

POST/payment/v1/bnpl-payments/init

İstek Parametreleri

apmType
string
zorunlu

Alışveriş Kredisi Sağlayıcısı

Değerler:
MASLAK
ALFABANK
TOM_FINANCE
HASO
merchantApmId
number

Ödeme alınmak istenen APM Id değeri. Merchant panelinde APM tanımlaması yapıldığında verilen ID değeridir. Birden fazla aynı tipte APM olduğu durumda gönderilmelidir

conversationId
string

İ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

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

price
decimal
zorunlu

Toplam ödeme tutarı. Sepetteki ürün/hizmet tutarları toplamının bu tutara eşit olması gerekmektedir

paidPrice
decimal
zorunlu

Komisyon ve indirim gibi farklar dahil edilerek hesaplanan, karttan çekilecek nihai tutar. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir. İşlemde vade farkı var ise vade farkı eklenmiş tutar bu parametreye girilmelidir.

buyerMemberId
number

Ö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

currency
Currency
zorunlu

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

Değerler:
TRY
paymentGroup
PaymentGroup
zorunlu
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentChannel
string

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.

callbackUrl
string
zorunlu

APM'den dönen sonucu üye işyerine iletmek için kullanılacak callback adresi

apmOrderId
string

Ö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.

apmUserIdentity
string

Ödeme yapacak olan kullanıcının APM sistemindeki eşsiz değeri.

additionalParams
map

Gerekli olan ekstra parametreler burada gönderilebilir. Ilgili APM tipine göre gönderilecek parametreler değilebilir. Detay için bkz. Alternatif Ödeme Yöntemleri

clientIp
string

Ödeme yapan alıcının IP adresi.

items
PaymentItem[]
zorunlu

Ö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

bankCode
string
zorunlu

Kredi başvurusu yapılmak istenen banka kodu

cartItems
BnplPaymentCartItem[]
zorunlu

Kredi sepetine ait 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

Dönen parametreler de 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:

paymentId
number

Bekleme durumunda oluşturulan ödemenin id bilgisi

paymentStatus
PaymentStatus

Ödeme durumunu ifade eder. WAITING olduğu durumlarda yönlendirme bekleniyordur, SUCCESS ise ödeme tamamlanmış demektir.

Değerler:
FAILURE
SUCCESS
INIT_THREEDS
CALLBACK_THREEDS
WAITING
additionalAction
AdditionalAction

Bazı APM entegrasyonlarında ekstra yapılması gereken işlemler olabildiği gibi bazılarında ise bu işleme gerek yoktur. NONE dönüldüğü durumlarda APM ödemesi için ekstra bir işlem yapılmasına gerek yoktur. Bkz. APM Ek Aksiyonlar

Değerler:
REDIRECT_TO_URL
NONE
redirectUrl
string

APM tarafından dönülen, ödeme işleminin devam edeceği URL bilgisi

paymentError
PaymentError

Ödeme aşamasında herhangi bir hata oluşursa hataya ait detayları içerir

Örnek Kodlar

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

Loading..