Başvuru Durum Sorgulama
Lead ve Register endpoint servisleri üzerinden Ödeal tarafına iletilen başvuru kaydının durumu sorgulanmak istendiğinde Register Status endpointi kullanılmalıdır. Başvuru durumu 2 farklı parametre (registerRefCode veya externalRegistrationId) ile sorgulanabilir.
Örnek Request
| HttpStatusCode | Request | Response |
|---|---|---|
| 422 | https://stage.odealapp.com/lead-api/v1/register/21d01292-68d1-48ab-bedf-1a6f95eb7827 | { "error": { "code": "REG-STATUS-REGISTER-NOT-FOUND-1", "message": "Başvuru bulunamadı" } } |
| 200 | https://stage.odealapp.com/lead-api/v1/register/084f727c-8a3c-45ea-8eb7-6b32e998feca | { "status": "INPROGRESS", "reason": null, "merchantRefCode": null, "externalMerchantId": null, "devices": [ { "externalDeviceId": null, "terminalSerialNumber": null, "terminalSetupKey": null, "terminalPhysicalSerialNumber": null, "installationDate": null, "setupCity": "İstanbul", "setupTown": "Kağıthane", "setupAddress": "Adres", "status": "INPROGRESS", "reason": null } ] } |
Response
| Alan | Tip | Açıklama |
|---|---|---|
| status | Text | Başvurunun durumunu gösterir. Bu alan için 3 durum vardır. INPROGRESS -Başvurunuz henüz beklemede. APPROVED - Başvurunuz onaylandı. REJECTED- Başvurunuz iptal edildi. |
| reason | Text | Status= REJECTED ise başvurunun red nedenini döner. - Başvuru, Ödeal tarafından iptal edilmiştir - Başvuru, iş ortağı tarafından iptal edilmiştir |
| merchantRefCode | Text | Ödeal tarafında üye işyerine özel tutulan tekil referans numarası. Status = APPROVED ise dolu olarak döner. |
| externalMerchantId | Text | İş ortağına ait üye işyeri ID’si |
| devices.externalDeviceId | Text | İş ortağına ait üye işyeri terminal ID’si |
| devices.terminalSerialNumber | Text | Banka pos tanımlamaları yapılabilmesi için cihazın mali numarası değeridir. Status =APPROVED ise dolu olarak döner. |
| devices.terminalSetupKey | Text | Cihaz kurulumunu Ödeal yapmayacaksa kurulumun yapılması için cihaz girilmesi gereken değerdir. Status =APPROVED ise dolu olarak döner. |
| devices.terminalPyhsicalSerialNumber | Text | Status = APPROVED ise (cihaz kurulumu tamamlandığında) dolu olarak döner. Cihaz ait fiziksel seri numarasını gösterir. |
| devices.installationDate | DateTime | Status = APPROVED ise(cihaz kurulumu tamamlandığında) dolu olarak döner. Cihazın kurulum tarih saat bilgisini verir.Başvuru onaylanmadığı her durumda boş olarak döner. |
| devices.setupCity | Text | Cihaz kurulumunun yapılacağı il bilgisini içerir. Örneğin; İstanbul |
| devices.setupTown | Text | Cihaz kurulumunun yapılacağı ilçe bilgisini içerir. Örneğin; Kadıköy |
| devices.setupAdress | Text | Cihaz kurulumunun yapılacağı açık adres bilgisini içerir. |
| devices.status | Text | Device sınıfının içinde dönen bu değer, cihazın durumunu gösterir. INPROGRESS - Kurulum yapılmadı. APPROVED - Kurulum tamamlandı. REJECTED - Başvuru iptal edildi. |
| devices.reason | Text | Cihazla ilgili açıklama bilgisinin tutulduğu bölümdür. |
Hata Kodları
| Kodu | Açıklama |
|---|---|
| GENE1 | Beklenmedik bir hata oluştu |
| REG-STATUS-REGISTER-NOT-FOUND-1 | Başvuru bulunamadı |
| REG-STATUS-EXTERNAL-REGISTRATION-ID-1 | ExternaRegistrationId boş gönderilemez |
| REG-STATUS-EXTERNAL-REGISTRATION-ID-AND-OWNER-1 | Girdiğiniz ExternaRegistrationId ile başvurunuz bulunmuyor |
| REG-STATUS-REGISTER-REF-CODE-AND-OWNER-1 | Girdiğiniz RegisterRefCode ile başvurunuz bulunmuyor |