Alıcı sorgulamak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.
| HTTP Metod | URL | URL Parametreleri |
|---|---|---|
GET |
/onboarding/v1/buyers/:id |
id: Alıcı ID değeri |
Alıcı sorgulama işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:
| Parametre Adı | Tipi | Her Zaman Mevcut | Açıklama |
|---|---|---|---|
id |
long |
Evet | Alıcı ID değeri |
status |
string |
Evet | Alıcının statüsünü gösteren değerdir. Aktif alıcılar için ACTIVE pasif statüdekiler için PASSIVE statüsü döner. |
email |
string |
Evet | Alıcıya ait email bilgisi |
identityNumber |
string |
Evet | Alıcıya ait kimlik numarası |
name |
string |
Evet | Alıcı ismi |
surname |
string |
Evet | Alıcı soyismi |
gsmNumber |
string |
Evet | Alıcıya ait telefon numarası |
buyerExternalId |
string |
Evet | Alıcıya ait external ID değeri |
Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz