Temel Kavramlar
API ile çalışırken sıkça karşılaşacağınız terimler ve kavramlar.
Başvuru (Register/Lead)
Ödeal sistemine yeni bir üye işyeri kaydı oluşturma işlemi.
registerRefCode
Ödeal tarafından oluşturulan benzersiz başvuru kimlik numarası (GUID formatında).
Örnek: 52127791-94bf-4c77-b345-8e396b05c767
externalRegistrationId
İş ortağının kendi sisteminde kullandığı başvuru kimlik numarası.
NE İŞE YARAR?
Aynı başvuruyu tekrar göndermek isterseniz, aynı externalRegistrationId ile istek atabilirsiniz. Eğer başvuru zaten varsa, mevcut başvurunun registerRefCode'u döner.
Dosya Yönetimi
fileId
Yüklenen her dosya için Ödeal tarafından oluşturulan benzersiz kimlik.
Dosya Tipleri (type)
- identity: Kimlik belgesi
- signature: İmza sirküleri
- taxPlate: Vergi levhası
- contract1/contract2: Sözleşme belgeleri
- gmuRegister: IVD üzerinden yapılan başvuru PDF'i
- edocSignature: E-belge imza yetkilisi belgesi
Şirket Bilgileri
businessType
Şirket türü:
- INDIVIDUAL: Şahıs şirketi
- CORPORATE: Tüzel şirket
routingModel
İşlem yönlendirme modeli - işlemlerin hangi kanaldan geçeceğini belirler:
| Model | Açıklama |
|---|---|
| MODEL0 | Tüm işlemler Ödeal üzerinden |
| MODEL1 | Tek çekim tamamı + Kendi bankam taksitli = Banka Diğer taksitler = İzin yok |
| MODEL2 | Tek çekim tamamı + Kendi bankam taksitli = Banka Diğer taksitler = Ödeal |
| MODEL3 | Kendi bankam işlemler = Banka Diğer işlemler = Ödeal |
İPUCU
Routing model, iş ortağınıza özel olarak belirlenir ve değişiklik yapılamaz.
Cihaz Bilgileri
terminalSerialNumber
Banka POS tanımlamaları için kullanılan mali seri numarası.
terminalPhysicalSerialNumber
Cihazın fiziksel seri numarası.
terminalSetupKey
Cihaz kurulumu için gerekli aktivasyon anahtarı.
cashRegisterType
Cihaz modeli:
- A920Pro
- D230
- A910
- A910S
- 5000F
- S920
Başvuru Durumları
Status Değerleri
| Durum | Anlamı |
|---|---|
| INPROGRESS | Başvuru inceleniyor |
| APPROVED | Başvuru onaylandı |
| REJECTED | Başvuru reddedildi |
Servis Yönetimi
claimId
Ödeal tarafından oluşturulan servis talebi kimlik numarası.
externalClaimId
İş ortağının kendi sisteminde kullandığı servis talebi kimlik numarası.
Servis Tipleri (type)
- ARIZA: Cihaz arıza bildirimi
- MALZEME: Malzeme/yedek parça talebi
- VERSIYON: Yazılım güncelleme talebi
typeDetail
Servis tipine göre detay bilgisi:
- ARIZA için: Arıza tipi ID'si (örn: 16 - Tekrar Deneyin Hatası)
- MALZEME için: Malzeme türü ID'si (örn: 1 - Rulo)
- VERSIYON için: Boş bırakılır
Satış Bilgileri
salesType / service
Sunulacak hizmet türü:
- EDOC_POS: 507 çözümü (E-Belge + POS)
- PHY_POS: Sade POS çözümü
- CeptePOS: Cepte POS çözümü
- SanalPOS: Sanal POS çözümü
type (Satış Tipi)
- LOAN: Kiralama (Yazar kasa entegrasyonunda sadece bu değer kullanılır)
Özel Alanlar
customInfo
İş ortağına özel key-value çiftleri. Raporlama ve takip için kullanılabilir.
{
"customInfo": {
"orderId": "987654",
"branchCode": "0001",
"salesPerson": "Ahmet Y."
}
}MCC Code
Merchant Category Code - İşyerinin faaliyet alanını belirten sınıflandırma kodu.
Örnek: 5411 - Süpermarket
Adres Bilgileri
city
İl bilgisi - Büyük/küçük harf duyarlıdır.
Örnek: İstanbul ✅ | istanbul ❌
town
İlçe bilgisi - İl ile uyumlu olmalı, büyük/küçük harf duyarlıdır.
Örnek: Kadıköy ✅ | kadıköy ❌
IBAN
TR ile başlayan 26 karakterli uluslararası banka hesap numarası.
İletişim Bilgileri
mobile / phone
10 haneli telefon numarası (başında 0 olmadan).
Örnek: 5321234567 ✅ | 05321234567 ❌
tcNumber
11 haneli TC Kimlik Numarası.
taxNumber
10 veya 11 haneli vergi numarası.
Sık Kullanılan Kısaltmalar
| Kısaltma | Açılımı |
|---|---|
| API | Application Programming Interface |
| GUID | Globally Unique Identifier |
| POS | Point of Sale |
| IVD | İnternet Vergi Dairesi |
| MCC | Merchant Category Code |
| TC | Türkiye Cumhuriyeti |
YARDIM
Bu terimleri API endpoint dokümantasyonunda sıkça göreceksiniz. Herhangi bir terimin anlamı hakkında emin değilseniz bu sayfaya dönebilirsiniz.