Ödeme alma servisi

Endpoint

/payment

Method Type

POST

Request Example and Description

Example Request:

{
    "paymentAmount": 500,
    "paymentAmountWithInstallmentFee": 500,
    "accountKey": "905110001111",
    "basketItems": [
{
    "product": "Test ürün 1",
    "price": 500,
    "CategoryId" :"1"
}
    ],
    "force3ds": true,
    "merchantOrderNumber": "test order",
    "bankOrderId": "",
    "cardToken": "test card token",
    "installment": 1,
    "rewardMoneyUsage": {
    "CardRewardMoney" : 100
},
    "Card": {
    "HolderName": "test card",
    "Number": "4132260000000003",
    "ExpireYear": "28",
    "ExpireMonth": "12",
    "Cvv": "000"
},
    "posAlias": null,
    "clientIp": "192.168.2.111"
}

Descriptions

InputName

Type

Required

Description

paymentAmount

int

Ödeme yapılması istenen ham tutar

paymentAmountWithInstallmentFee

int

Taksit vade farkı eklenmiş son ödeme tutarı

accountKey

object

Kullanıcının istek yaptığı IP bilgisi (Son kullanıcının bilgisayar IP'si)

BasketItems

List<Product>

Sepet içerisindeki ürün bilgileri(Sepet içerisindeki toplam değer price amount a eşit olmalıdır)

OutputName	Type	Description
Product	string	Ürün bilgisi
Price	int	Ürün tutar bilgisi
SubMerchantMemberId	int?	Merchant bir pazar yeri ise satıcının Craftgate üye ID zorunludur.
SubMerchantMemberPrice	int?	Merchant bir pazar yeri ise sepete eklenen ürün için satıcının hakediş tutarı bilgisi zorunludur.
CategoryId	string	Merchant tarafında satılan ürünün kategori identity bilgisidir. Örnek: "0002131" Kodu: 0002131 Kategori Kodu Açıklaması: Tekstil
ExternalId	string	İlgili ürün ya da hizmeti ifade eden dış ID değeri. Genellikle üye işyeri sisteminde bu kırılıma ilişkin ID değeri kullanılır.

force3ds

int

Ödemeyi zorunlu olarak 3ds ile geçirmek isterseniz true gönderebilirsiniz

merchantOrderNumber

string

Üye işyerine ait sipariş numarası

bankOrderId

string

Ödeme alınırken bankaya iletilecek orderId parametresi

cardToken

string

Saklı kart servisinden iletilen card token bilgisi (Kullanıcının seçtiği kart bilgisi) (Saklı kart ile ödeme yapılacak ise gönderilmelidir)

card

object

Eğer kullanıcı yeni bir kart ile ödeme geçecek ise bu bilgiler gönderilmelidir

OutputName	Type	Description
holderName	string	Kart sahibinin adı soyadı
number	string	Kart numarası
expireYear	string	Kart son kullanma tarihi (yıl)
ExpireMonth	string	Kart son kullanma tarihi (ay)
cvv	string	Kart cvv bilgisi

rewardMoneyUsage

Eğer kart puanı kullanılacak ise bu bilgi iletilmelidir.

OutputName	Type	Required	Description
CardRewardMoney	int		Puan tutarı

posAlias

string

Ödemenin geçmesini istediğiniz pos bilgisi(Boş geçilirse, en uygun pos kullanılacaktır)

clientIp

string

Kullanıcının istek yaptığı IP bilgisi (Son kullanıcının bilgisayar IP'si)

Response Example and Description

Example Response:

{
    "Bank3DFormUrl": "http://banksite.com/payment",
    "Success": true,
    "MessageCode": "0000",
    "Message": "İşlem Başarıyla Gerçekleştirildi.",
    "UserMessageTitle": null,
    "UserMessage": "İşlem Başarıyla Gerçekleştirildi."
}

InputName	Type	Description
Bank3DFormUr	string	Eğer ödeme 3ds ile geçiliyor ise bu alan dolu gelecektir. Kullanıcının karşısında açılması gereken banka 3ds ekranı URL'idir

Ödeme alma - 3ds dönüşü

3ds ödemelerinde, ödeme tamamlama dönüşü

Method Type

GET

Request Example and Description

Example Request:

{
    "merchantOrderNumber ": "test order",
    "PaymentId ": "1122334455",
    "IsPaymentSuccessful ": true,
    "MdStatus ": 1,
    "PaymentType ": 2,
    "HPReferenceNo ": "hpreferenceno"
}

Descriptions

InputName

Type

Description

merchantOrderNumber

string

Üye işyerine ait sipariş numarası

PaymentId

string

Payment provider sisteminde bulunna ödeme Id'si

IsPaymentSuccessful

bool

Ödeme başarılı tamamlandı mı?

MdStatus

int

3D Secure doğrulamasının sonucunu ifade eden değer.

PaymentType

enum

Ödemenin hangi ödeme yöntemi ile geçildiği bilgisi

PaymentType	Description
1	Wallet
2	CreditCard
3	ShoppingLoan

HPReferenceNo

string

Hepsipay sisteminde bulunun ödeme referans numarası

Kart Puanı Servisi Açık Kaynak