Hesap varlığı doğrulama

GET 
/api/account/exists

Belirtilen sandbox e-posta adresleri için Volet.com hesaplarının olup olmadığını kontrol eder.

İstek

Query parametreleri

emailsToValidate string[]zorunlu
Doğrulanacak e-posta adresleri. Yalnızca sandbox veya test adresleri kullanın.
Örnek: [email protected]

Yanıtlar

200

OK

application/json

Şema

Şema

• Array [
accountEmailstring
Hesap e-postası.
Örnek: [email protected]
presentboolean
Varlık göstergesi.
Örnek: true
transactionScoreint32
İşlem puanı.
Örnek: 1
verifiedboolean
Doğrulama göstergesi.
Örnek: true
• ]

Örnek

[
  {
    "accountEmail": "[email protected]",
    "present": true,
    "transactionScore": 1,
    "verified": true
  }
]

400

Hatalı istek. İstek hatalı biçimlendirilmiş veya geçersiz parametreler içeriyor.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: disabled
errorTypestringzorunlu
Hata kategorisi.
Örnek: FORM
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Yetkisiz. Üye işyeri kimlik doğrulama başlıkları eksik veya geçersiz.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: userDoesNotExistException
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Bulunamadı. İstenen kaynak mevcut değil.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: resourceNotFound
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: Resource not found
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Sunucu iç hatası. Beklenmeyen hata, lütfen destek ekibiyle iletişime geçin

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: internalServerError
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: Internal server error
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}