Üye Arama

Üye aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

URL

HTTP Metod URL URL Parametreleri
GET /onboarding/v1/members URL parametreleri için bknz. Üye arama URL parametreleri

İstek Parametreleri

Varolan bir üyeyi aramak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
isBuyer boolean Hayır Üyenin alıcı olma durumu
isSubMerchant boolean Hayır Üyenin satıcı olma durumu
memberType MemberType Hayır Üye türü. bknz: Üye Tipleri
memberExternalId string Evet Üye dış ID değeri
memberIds number[] Evet Üye ID listesi
name string Hayır Üye ismi
page number Hayır Sayfalama için sayfa sayısı
size number Hayır Sayfalama için sonuç sayısı

Dönüş Parametreleri

Üye güncelleme işlemi 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 Açıklama
id number Üye ID değeri
createdDate date Üye yaratılan tarih
updatedDate date Üye güncellenen tarih
status Status Üye durumunu gösteren değerdir. bknz: Durum
isBuyer boolean Üyenin alıcı olma durumu
isSubMerchant boolean Üyenin satıcı olma durumu
memberType MemberType Üye türü. bknz: Üye Tipleri
memberExternalId string Üye dış ID değeri
name string Üye ismi
address string Üye adresi
email string Üyeye ait email bilgisi
iban string Üyeye ait iban bilgisi
settlementEarningsDestination SettlementEarningsDestination Üye kazançları dağıtım yeri. bknz: Para Gönderim Yerleri
negativeWalletAmountLimit decimal Üye cüzdanı için eksi bakiye alt limiti belirleyebilirsiniz. 0'dan küçük bir değer olmalıdır.
phoneNumber string Üye telefon numarası
taxOffice string Üye vergi dairesi
taxNumber string Üye vergi no
contactName string Üye ulaşılabilir kişi ismi
contactSurname string Üye ulaşılabilir kişi soyismi
identityNumber string Kimlik numarası
legalCompanyTitle string Resmi şirket ismi

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.