Skip to content

Register - Başvuru Durumu Sorgulama

Ödeal'da daha önce oluşturulmuş bir register başvurusunun durumunu sorgulamak için kullanılan, GET metoduyla çalışan servistir.

Servise iletilen isteğin başarılı olması durumunda, servis başvurunun detaylı bilgilerini ve mevcut durumunu döndürür. GET isteği başarısız olduğunda hata kodu ve mesajı response çıktısında görüntülenecektir.

API Reference: Register Status

Not: Bu servis hem registerRefCode hem de externalRegistrationId parametresi ile çalışır. URL path'inde bu değerlerden biri gönderilmelidir. externalRegistrationId sadece başvuru sırasında gönderilmişse kullanılabilir.

Bu servis ile mevcut bir register başvurusunun durumu, işlem geçmişi ve tüm detayları sorgulanabilir.

Endpoint

GET /register/{registerRefCode}

veya

GET /register/{externalRegistrationId}

Örnek İstekler

RegisterRefCode ile Sorgulama

GET https://stage.odealapp.com/lead-api/v1/register/3e60eb91-241a-467c-a41c-cbf558f46b9a

ExternalRegistrationId ile Sorgulama

GET https://stage.odealapp.com/lead-api/v1/register/EXTERNAL_REG_ID_123

Not: externalRegistrationId ile sorgulama yapabilmek için, başvuru oluşturulurken bu değerin gönderilmiş olması gerekir.

Response Örnekleri

Başarılı (200) - RegisterRefCode ile

Request

GET /register/3e60eb91-241a-467c-a41c-cbf558f46b9a

Response

json
{
  "status": "INPROGRESS",
  "registerCallStatus": null,
  "crmRecordId": "MyIyMTc1MSIsImRlmF1bHRTYWxlc0dOdlbmVyYWwiXQ==",
  "reason": null,
  "merchantRefCode": null,
  "externalMerchantId": null,
  "phone": null,
  "email": null,
  "tckn": null,
  "vkn": null,
  "iban": null,
  "devices": [
    {
      "externalDeviceId": null,
      "terminalSerialNumber": null,
      "terminalSetupKey": null,
      "terminalPhysicalSerialNumber": null,
      "installationDate": null,
      "setupCity": null,
      "setupTown": null,
      "setupAddress": null,
      "status": "INPROGRESS",
      "reason": null,
      "refundType": null
    }
  ]
}

Başarılı (200) - ExternalRegistrationId ile

Request

GET /register/EXTERNAL_REG_ID_123

Response

json
{
  "status": "INPROGRESS",
  "registerCallStatus": null,
  "crmRecordId": "MyIyMTc1MSIsImRlmF1bHRTYWxlc0dOdlbmVyYWwiXQ==",
  "reason": null,
  "merchantRefCode": null,
  "externalMerchantId": null,
  "phone": null,
  "email": null,
  "tckn": null,
  "vkn": null,
  "iban": null,
  "devices": [
    {
      "externalDeviceId": null,
      "terminalSerialNumber": null,
      "terminalSetupKey": null,
      "terminalPhysicalSerialNumber": null,
      "installationDate": null,
      "setupCity": null,
      "setupTown": null,
      "setupAddress": null,
      "status": "INPROGRESS",
      "reason": null,
      "refundType": null
    }
  ]
}

Başarısız (422 Unprocessable Entity)

Request

GET /register/geçersiz-register-ref-code

Response

json
{
  "error": {
    "code": "REG-STATUS-REGISTER-NOT-FOUND-1",
    "message": "[OdealDemoUser] Başvuru bulunamadı"
  }
}

Başarısız (422 Unprocessable Entity) - Farklı Kullanıcı

Request

GET /register/başka-kullanıcının-ref-code

Response

json
{
  "error": {
    "code": "REG-STATUS-REGISTER-NOT-FOUND-1",
    "message": "[OdealDemoUser] Başvuru bulunamadı"
  }
}

Başarısız (401 Unauthorized)

Request

GET /register/3e60eb91-241a-467c-a41c-cbf558f46b9a

Geçersiz veya eksik authentication token ile

Response

401 Unauthorized

Response Alanları

AlanTipAçıklama
statusstringBaşvurunun genel durumu (INPROGRESS, COMPLETED, REJECTED vb.)
registerCallStatusstring/nullRegister çağrısının durumu
crmRecordIdstringCRM sistemindeki kayıt ID'si
reasonstring/nullDurum değişikliği sebebi
merchantRefCodestring/nullÜye işyeri referans kodu
externalMerchantIdstring/nullHarici üye işyeri ID'si
phonestring/nullTelefon numarası
emailstring/nullE-posta adresi
tcknstring/nullTC Kimlik Numarası
vknstring/nullVergi Kimlik Numarası
ibanstring/nullIBAN numarası
devicesarrayTerminal cihazları listesi

Device Alanları

AlanTipAçıklama
externalDeviceIdstring/nullHarici cihaz ID'si
terminalSerialNumberstring/nullTerminal seri numarası
terminalSetupKeystring/nullTerminal kurulum anahtarı
terminalPhysicalSerialNumberstring/nullTerminal fiziksel seri numarası
installationDatestring/nullKurulum tarihi
setupCitystring/nullKurulum şehri
setupTownstring/nullKurulum ilçesi
setupAddressstring/nullKurulum adresi
statusstringTerminal durumu
reasonstring/nullDurum değişikliği sebebi
refundTypestring/nullGeri Ödeme Tipi

Ödeal A.Ş.