Ana içeriğe geç

Parçalı Ödeme Alma

Parçalı Ödeme Başlatma

URL

Parçalı ödeme başlatmak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

POST/payment/v1/mult-payments/init

Parçalı Ödeme Başlatma İsteği Parametreleri

Parçalı ödeme ile yapılacak ödemelerde diğer ödemelerden farklı olarak callbackUrl parametresinin gönderilmesi zorunludur ve kart bilgileri beklenmez. İlgili kullanıcının saklı kartlarını kullanabilmesi için cardUserKey parametresi doldurulabilir. Bu bağlamda parçalı ödeme ile bir ödeme başlatmak için gereken parametreler aşağıdaki gibidir

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

externalId
string

Genellikle üye işyeri tarafındaki, ödemeye ilişkin sipariş numarası veya sepet numarası olarak kullanılır. Daha sonradan sorgulama servislerinde bu id ile sorgulama yapabilirsiniz.

orderId
string

Ödeme alınırken banka yada alternatif ödeme yöntemlerine iletilecek orderId parametresi. Opsiyonel olduğu için gönderilmemesi ve orderId değerinin Craftgate tarafından üretilmesi önerilir.

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, müşterinin ödeyeceği toplam tahsilat tutarı. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir

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
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
paymentGroup
PaymentGroup
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentSource
PaymentSource
Değerler:
API
CHECKOUT_FORM
PAY_BY_LINK
paymentPhase
PaymentPhase

bkz: Ödeme Fazları - Provizyon kapama için bkz: Provizyon Kapama

Değerler:
AUTH
PRE_AUTH
POST_AUTH
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

Parçalı ödeme sayfasındaki ödemeler tamamlandığında çağırılacak URL adresi

cardUserKey
string

Kart kullanıcı anahtarı

allowOnlyCreditCard
boolean

Eğer true olarak yollanırsa kullanıcıdan sadece kredi kartı ile ödeme alınır

allowOnlyStoredCards
boolean

Eğer true olarak yollanırsa kullanıcı sadece saklı kartlarını kullanarak ödeme yapabilir. Bu değer true olarak yollandığı takdirde cardUserKey parametresi gönderilmelidir.

alwaysStoreCardAfterPayment
boolean

Eğer true olarak yollanırsa kullanıcının ödeme için kullandığı kart saklanacaktır. Bu değer true olarak yollandığı takdirde allowOnlyStoredCards parametresi gönderilmemelidir.

allowDeleteStoredCard
boolean

Eğer true olarak yollanırsa veya parametre hiç gönderilmezse saklı kartların yanında silme aksiyonu gösterilir. Yalnızca false gönderilirse saklı kart silme alanı gizlenir.

allowInstallmentOnlyCommercialCards
boolean

Eğer true olarak yollanırsa Ortak Ödeme Formu üzerinden sadece ticari kart sahipleri için taksit seçenekleri gösterilecektir.

forceAuthForNonCreditCards
boolean

Eğer true olarak yollanırsa Ortak Ödeme Formu üzerinden ön provizyon PRE_AUTH kullanılmak isteniyorsa, kredi kartı dışındaki kart tiplerine provizyon ödemesi AUTH zorunlu kılınır.

disableStoreCard
boolean

Eğer true olarak yollanırsa kullanıcıya kartını saklama seçeneği sunulmaz.

forceThreeDS
boolean

Eğer true olarak yollanırsa kullanıcının 3DS ödeme gerçekleştirmesi zorunlu kılınır.

ttl
long

Bu istekte başlatılan ödeme isteğinin dakika cinsinden ne kadar süre kullanılabileceğini belirleyen parametre.

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

masterpassGsmNumber
string

(bkz. Masterpass) Eğer kullanıcının Masterpass ile ödeme yapabilmesi isteniyorsa, kullanıcının Masterpass ile ilişkilendirilmiş telefon numarası 90 ile başlayacak şekilde girilmelidir. Girmediğiniz takdirde ya da girmiş olduğunuz telefon numarası Masterpass ile daha önce ilişkilendirilmediyse, ödeme formunda Masterpass tabı açılmayacaktır.

masterpassUserId
string

(bkz. Masterpass) Eğer kullanıcının Masterpass ile ödeme yapabilmesi isteniyorsa, ve kullanıcının Masterpass hesabı, üye işyeri ile daha önce Craftgate entegrasyonu dışında bir ortam üzerinden ilişkilendirildiyse, ilişkilendirme aşamasında kullanılan userId değeri.

apmUserIdentity
string

(bkz. Payoneer) Eğer kullanıcının Payoneer ile ödeme yapabilmesi isteniyorsa, ödeme yapacak olan kullanıcı ile ilişkili eşsiz değer.

enabledPaymentMethods
PaymentMethod[]

Parçalı ödeme sayfasında görünmesi istenen ödeme yöntemlerini bu parametre ile yönetebilirsiniz. Eğer sadece [CARD] olarak yollanırsa kullanıcı sadece kartla ödeme yapabilir. Listelenmesini istediğiniz ödeme yöntemleri için (bkz. Ödeme Yöntemleri). Hiç gönderilmediğinde mevcuttaki tüm ödeme yöntemleri listelenir.

maximumSplitPaymentCount
number

Parçalı ödeme işlemi kapsamında izin verilen maksimum başarılı ödeme sayısıdır.

additionalParams
map

Gerekli olan ekstra parametreler burada gönderilebilir.

Dönüş Parametreleri

Parçalı ödeme 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:

token
string

Parçalı ödeme sayfası başlangıç isteği için oluşturulan alfanumerik değer

pageUrl
string

Parçalı ödeme sayfası başlagıç isteği üzerine oluşturulan ve kullanıcının ödeme yapması için ziyaret etmesi gereken sayfa URL değeri

tokenExpireDate
date

Parçalı ödeme sayfası için geçerlilik süresi

Parçalı Ödeme Sorgulama

Callback URL'e ya da Webhook Url'e iletilen token değeri ile parçalı ödeme sonucu sorgulanabilir.

URL

Parçalı ödemeleri sorgulamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

GET/payment/v1/multi-payments/:token

Parçalı Ödeme Sorgulama Dönüş Parametreleri

Parçalı ödemelerin sorgulama isteklerine verilen cevap aşağıda yer almaktadır

id
number

Parçalı Ödemenin ID'si. Bu değer parçalı ödeme isteği için Craftgate tarafından belirlenen eşsiz değerdir.

multiPaymentStatus
MultiPaymentStatus

Parçalı Ödeme Durumu

token
string

Parçalı ödemeye ait token değeri

tokenExpireDate
date

Parçalı ödeme için geçerlilik süresi

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

remainingAmount
decimal

Parçalı ödemenin henüz tahsil edilmemiş tutarı

conversationId
string

Üye işyeri tarafından gönderilen conversationId değeri

externalId
string

Üye işyeri tarafından gönderilen externalId değeri

paymentIds
array

Parçalı ödeme için gerçekleştirilen başarılı ve başarısız tüm ödemelere ait id bilgisi

Örnek Kodlar

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