Ortak Ödeme Veri/Alan Açıklamaları

Web Servis Alanları Açıklamaları

Alan Adı

Açıklama

Zorunluluk

Format

Format Açıklaması

1

Version

API Versiyonu

zorunlu

string

API versiyonudur, güncel versiyon 1.0’dır.

2

ApiKey

Üye İşyeri Tanımlayıcısı

zorunlu

string

Üye işyerine özel tanımlayıcı bilgi

3

TransactionId

Ödemeye Ait Tekil Kodu

zorunlu

string

Maksimum 40 karakterdir

4

TransactionTime

İşlem Zamanı

zorunlu

string

Unix timestamp

5

Signature

Güvenlik İmzası

zorunlu

string

sha256 [ SecretKey & TransactionId & TransactionTime &
Amount & Currency & Installment]

6

Description

Açıklama alanıdır

opsiyonel

string

Maksimum 40 karakterdir

7

Amount

Toplam Ödeme Tutarı

zorunlu

int

Nokta ve virgülden arındırılmış int değerdir

8

Currency

Toplam Ödeme Tutar Birimi

opsiyonel

string

3 harfli ISO standart değeridir

9

Installment

Ödeme Taksit Sayısı

opsiyonel

int

1 den 12 ye kadar taksit değeridir

10

Card /
CardHolderName

Kart İsim Soy isim

opsiyonel

string

Maksimum 40 karakterdir. Sadece alfabetik karakterler ve boşluk kabul eder.

11

Card /
CardNumber

Kart Numarası

zorunlu

string

15 veya 16 haneli nümerik değerdir.

12

Card /
ExpireYear

Kart Son Kullanım Tarihi

zorunlu

string

2 haneli nümerik değerdir.

13

Card /
ExpireMonth

Kart Son Kullanım Tarihi

zorunlu

string

2 haneli nümerik değerdir.

14

Card /
SecurityCode

Kart CVV

zorunlu

string

3 veya 4 haneli nümerik değerdir.

15

BasketItems /
Description

Ürün isimlerini içeren dizin

opsiyonel

string

Maksimum 40 karakterdir.

16

BasketItems /
BasketItemId

Ürün kodlarını içeren dizin

şarta bağlı

string

Maksimum 40 karakterdir.

17

BasketItems /
ProductCode

Ürün kodlarını içeren dizin

opsiyonel

string

Maksimum 36 karakterdir.

18

BasketItems /
Amount

Ürün fiyatlarını içeren dizin

şarta bağlı

int? (nullable)

Nokta ve virgülden arındırılmış double değerdir.

19

BasketItems /
VatRatio

Tutarın KDV içerip
içermediğini belirten dizin

opsiyonel

int? (nullable)

0, 8 veya 18 değerlerini alabilir.

20

BasketItems /
BasketItemType

Üye iş yeri tipi

şarta bağlı

int

Ürünler için 1, Kargo bilgisi için 3 gönderilir.

21

BasketItems /
Count

Her bir ürünün
miktarını içeren dizin

şarta bağlı

int

Maksimum 3 haneli nümerik değerdir.

22

BasketItems /
Url

Ürün web adresi
Müşteri İsim

opsiyonel

string

Web URL adresidir.

23

Customer /
Name

Müşteri İsim

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik karakterler ve boşluk kabul eder.

24

Customer /
Surname

Müşteri Soy isim

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik karakterler ve boşluk kabul eder.

25

Customer /
Email

Müşteri Mail

opsiyonel

string

Eposta adresidir.

26

Customer /
IpAddress

Müşteri IP Adresi

zorunlu

string

IP adresidir.

27

Customer /
PhoneNumber

Müşteri Telefon Numarası

opsiyonel

string

Maksimum 13 karakterdir. Sadece nümerik ve + değerlerini alabilir.

28

Customer /
Code

Müşteri Kodu

opsiyonel

string

Maksimum 36 karakterdir.

29

Customer /
Tckn

Müşteri Kimlik Numarası

opsiyonel

string

TC Kimlik numarasıdır.

30

Customer /
VatNumber

Müşteri Vergi Numarası

opsiyonel

string

Şirketlere ve firmalara tekil vergi numarası

31

Customer /
MemberSince

Müşteri Üyelik tarihi

opsiyonel

int

Müşteri üyelik tarihi formatı YYYYMMDD’ dır.

32

Customer /
Birthdate

Müşteri Doğum tarihi

opsiyonel

int

Müşteri üyelik tarihi formatı YYYYMMDD’ dır.

33

ShippingAddress /
Address

Siparişin teslim edileceği adres

opsiyonel

string

Maksimum 500 karakterdir. Sadece alfa numerik karakterler,
&.,/: ve boşluk karakterini kabul eder.

34

ShippingAddress /
Name

Sipariş Teslimatının
yapılacağı kişi adı ve soyadı

opsiyonel

string

Maksimum 40 karakterdir. Sadece alfabetik karakterler ve boşluk kabul eder.

35

ShippingAddress /
Country

Sipariş teslimatının
yapılacağı ülke

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik olabilir.

36

ShippingAddress /
CountryCode

Sipariş teslimatının
yapılacağı ülke

opsiyonel

string

2 veya 3 haneli ISO ülke kodudur. Sadece alfabetik olabilir.

37

ShippingAddress /
City

Sipariş teslimatının
yapılacağı şehir

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik olabilir.

38

ShippingAddress /
CityCode

Sipariş teslimatının
yapılacağı şehir

opsiyonel

string

Şehire ait ulusal veya uluslararası kod alanıdır.
Türkiye için plaka kodu kullanılabilir.

39

ShippingAddress /
ZipCode

Sipariş teslimatının
yapılacağı posta kodu

opsiyonel

string

Uluslararası posta kodu alanıdır.

40

ShippingAddress /
District

Sipariş teslimatının
yapılacağı ilçe

opsiyonel

string

İlçe alanıdır.

41

ShippingAddress /
DistrictCode

Sipariş teslimatının
yapılacağı ilçe kodu

opsiyonel

string

İlçe kodu alanıdır.

42

ShippingAddress /
ShippingCompany

Taşıyıcı kargo bilgisi

opsiyonel

string

Taşıyıcı kargo bilgisi alanıdır.

43

InvoiceAddress /
Name

Fatura kesilecek
kişi veya kurum adı

opsiyonel

string

Maksimum 40 karakterdir. Sadece alfa nümerik karakterler,
& . ve boşluk karakterini kabul eder.

44

InvoiceAddress /
Address

Fatura adresi

opsiyonel

string

Maksimum 500 karakterdir. Sadece alfa nümerik karakterler,
&.,/: ve boşluk karakterini kabul eder.

45

InvoiceAddress /
Country

Fatura ülkesi

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik olabilir.

46

InvoiceAddress /
CountryCode

Fatura ülkesi

opsiyonel

string

2 veya 3 haneli ISO ülke kodudur. Sadece alfabetik olabilir.

47

InvoiceAddress /
City

Fatura şehri

opsiyonel

string

Maksimum 20 karakterdir. Sadece alfabetik olabilir.

48

InvoiceAddress /
CityCode

Fatura şehri

opsiyonel

string

Şehire ait ulusal veya uluslararası kod alanıdır.
Türkiye için plaka kodu kullanılabilir.

49

InvoiceAddress /
ZipCode

Fatura zip code

opsiyonel

string

Uluslararası posta kodu alanıdır.

50

InvoiceAddress /
District

Sipariş teslimatının
yapılacağı ilçe

opsiyonel

string

İlçe alanıdır.

51

InvoiceAddress /
DistrictCode

Sipariş teslimatının
yapılacağı ilçe kodu

opsiyonel

string

İlçe kodu alanıdır.

52

InvoiceAddress /
ShippingCompany

Taşıyıcı kargo bilgisi

opsiyonel

string

Taşıyıcı kargo bilgisi alanıdır.

53

Extras / Key

Ekstra eklenebilecek
veri alanı key

opsiyonel

string

Maksimum 40 karakterdir.

54

Extras / Value

Ekstra eklenebilecek
veri alanı key

opsiyonel

string

Maksimum 40 karakterdir.

55

MessageCode

Ödeme Sonuç Kodu

zorunlu

string

4 hane nümerik

56

Message

Ödeme Sonuç Mesajı

zorunlu

string

Maksimum 500 karakterdir.

57

UserMessage

Ödeme Sonuç
Kullanıcı Mesajı

zorunlu

string

Maksimum 500 karakterdir

58

SuccessUrl

SuccessUrl

zorunlu

string

3d secure işlemleri için zorunlu bir alandır. İşlemin başarılı olması durumunda
üye işyeri tarafından geliştirilmiş sayfanın URL adresi yazılmalıdır.

59

FailUrl

FailUrl

zorunlu

string

3d secure işlemler için zorunlu bir alandır. İşlemin başarılı olması durumunda
üye işyeri tarafından geliştirilmiş sayfanın URL adresi yazılmalıdır.

60

ReferenceTransactionId

İade Edilecek
Ödemeye Ait Tekil Kod

zorunlu

string

Maksimum 40 karakterdir

61

ReturnUrl

Ortak ödeme geribildiriminin yapılacağı adres

opsiyonel

String

Url formatında olmalıdır.

62

HasInstallmentChoice

Taksit seçeneği sunulacak mı?

opsiyonel

bool

true veya false değerini alabilir. Varsayılan değeri true’dur.

63

CommissionAmountReflect

Komisyon tutarı kime yansıtılsın?

opsiyonel

int

1: son kullanıcıya yansıt, 2: iş yerine yansıt.
Sadece “HasInstallmentChoice” değeri true ise geçerlidir.

64

CommonPaymentUniqueId

Ödemeyi temsil eden unique ID

zorunlu

string

Trim edilmiş GUID değerdir.

65

Status

Ödeme durumu

zorunlu

int

0 = işlem görmemiş, 1= sayfa çağırıldı ve
bekliyor, 2 = başarısız, 3 = başarılı

66

Success

Sorgulamanın sonucu

zorunlu

bool

Sorgulama başarıyla yapılmışsa true döner

67

PaymentTransactionReponseMessage

Ödeme Sonuç Mesajı

zorunlu

string

Maksimum 500 karakterdir.

68

PaymentTransactionResponseCode

Ödeme Sonuç Kodu

zorunlu

string

4 hane nümerik..

Signature Alanı Açıklamaları

Alan Adı

Açıklama

Zorunluluk

Format

Format Açıklaması

Örnek

5

Secret Key

Üye İşyeri Tanımlayıcı Şifresi

Zorunlu

string

Üye işyerine özel tanımlayıcı şifre bilgisi

123456

TransactionId

Ödemeye Ait Tekil Kodu

Zorunlu

string

Maksimum 40 karakterdir

TransactionId_1234

TransactionTime

Ödeme İşlem Zamanı

Zorunlu

string

Unix timestamp

1443600845

Amount

Toplam Ödeme Tutarı

Zorunlu

int

Nokta ve virgülden arındırılmış int değerdir

12000 Lira alanı ve Kuruş Alanı

Currency

Toplam Ödeme Tutar Birimi

Zorunlu

string

3 harfli ISO standart değeridir.

TRY

Installment

Ödeme Taksit Sayısı

Zorunlu

int

1'den 12'ye kadar taksit değeridir

1

ReferenceTransactionID**

İadeye Ait Tekil Kod

Zorunlu

string

Maksimum 40 karakterdir

TransactionId_2345