Ödeal’da bir üye işyeri oluşturmak ve oluşturulan üye iş yerine bir terminal tanımlayabilmek için kullanılan, POST metoduyla çalışan servistir. Servise iletilen isteğin başarılı olması durumunda, servis registerRefCode değeri döndürür. registerRefCode değeri Ödeal üzerinde oluşan Başvuru ID'sini temsil etmektedir.

Notlar

• Register’a istekte bulunmadan önce ilgili başvuru için gerekli evrakların v1/files servisine iletilip, files servisinden alınan response’taki fileId değerinin Register endpoint'indeki “files” objesi içerisindeki content alanına yazılmalıdır.
• Bir istekte 1’den fazla satış isteği iletilmemelidir. Herbir istek içerisinde sadece 1 hizmet (salesInfo/service) olmalı, aynı hizmet için birden fazla cihaz eklemesi yapılabilmektedir.
• Bir başvuru içerisinde birden fazla cihaz talebinde bulunulabilinir. Bunun için devices bölümü çoklanarak istek gönderilebilir. Tek bir cihaz üzerinden işlem yapılacaksa devices bölümünde bir dizi göndermek yeterlidir.
• Ödeal bu servis aracılığıyla bilgileri aldığı anda, standart onboarding operasyonel sürecini başlatır. Bu süre yaklaşık 3 iş günüdür.
• Bu süre zarfında servis aracılığıyla gönderilen verilerde Ödeal sistemi üzerinde değişiklik yapılabilir. Bu sebeple bundan sonraki tüm süreç servis içeriğinde iletilen bir alana değil, “registerRefCode” şeklinde üretilen yeni bir değere bağlanmıştır.
• Operasyonel süreç Ödeal tarafından olumsuz (sebebi ile birlikte) ya da olumlu sonuçlanırsa bu servisin çıktısı olarak verilen “registerRefCode” ile aşağıdaki Lead Callback servisi ile iş ortağına iletilir. Ya da iş ortağı Register Status başlığı altından enpoint ile başvuru durumunu registerRefCode / externalRegistrationId ile sorgulayabilir.
• “customInfo” alanında üye işyerine ait verilerden herhangi birinin, iş ortağının isteğine bağlı değerler gönderilmesi sağlanabilir.
• “files”, üye işyeriyle ilgili hardcopy dokümanların dijital ortama alındığı ve aktarımının yapıldığı alandır.
• TerminalPhysicalSerialNumber, iş ortağının üye işyerine teslim ettiği bir cihaz varsa kullanılır, yoksa boş olarak gönderilebilir.
• TerminalSerialNumber, Ödeal ve bankalar tarafında POS’ların tanımlı olacağı mali no değeridir.
  Gönderilen isteklerde kullanıcı bilgisine göre cashRegisterType, routingModel bölümlerinde kısıtlamalar mevcuttur. Kullanıcının kendi iş ortağı dışında bu alanlar için farklı bir değer gönderme durumunda hata alınacaktır.

Hata Kodları

Örnek Request

{
   "files": [
       {
           "source": "rest",
           "type": "identity",
           "content": "21d01292-68d1-48ab-bedf-1a6f95eb7827"
       },
       {
           "source": "rest",
           "type": "signature",
           "content": "1b88bf73-fe32-4cd9-a18e-89f8c1669574"
       },
       {
           "source": "rest",
           "type": "taxPlate",
           "content": "47faa8d3-9fd9-45f4-ae80-29a9ea2d1cb4"
       },
       {
           "source": "rest",
           "type": "gmuRegister",
           "content": "99f967c9-7e31-491f-b044-bd0d10aa226f"
       },
       {
           "source": "rest",
           "type": "edocSignature",
           "content": "fc775f55-6bdd-48be-bd34-6aeccad05a40"
       },
       {
           "source": "rest",
           "type": "contract1",
           "content": "4a57a9a2-0d52-4ada-aa84-0ce726428c4e"
       },
       {
           "source": "rest",
           "type": "contract2",
           "content": "c4756dd5-a2d7-4aeb-93a4-e53b1503991d"
       }
   ],
    "companyInfo": {
        "businessType": "CORPORATE",
        "tcCitizen": true,
        "tcNumber": "11111111111",
        "taxNumber": "2222222222",
        "externalMerchantId": "",
        "externalRegistrationId": "",
        "iban": "TR030006262254937598445356",
        "firstName": "Deneme",
        "lastName": "Test",
        "mobile": "5555555555",
        "email": "[email protected]",
        "companyTitle": "Deneme",
        "brandName": "Test Marka",
        "mcccode": "123456",
        "phone": "2120000101",
        "city": "İstanbul",
        "town": "Bahçelievler",
        "address": "Fevzi çakmak mah. erenler sokak no:39   Bahçelievler/İstanbul",
        "routingModel":"MODEL0"
    },
    "salesInfo": {
        "type": "LOAN",
        "service": "EDOC_POS",
        "note": "Test"
    },
    "customInfo": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
    },
    "devices": [
        {
            "cashRegisterType": "A910",
            "efaturaIntegrator": "ODEAL",
            "externalDeviceId": "",
            "posInstallmentType": true,
            "setupCity": "İstanbul",
            "setupTown": "Bahçelievler",
            "setupAddress": "Fevzi çakmak mah. erenler sokak no:39   Bahçelievler/İstanbul",
            "terminalSerialNumber": "",
            "terminalPhysicalSerialNumber": ""
        }
    ]
}