Üye oluşturmak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.
Üyeler 3 farklı tipte olabilir:
(Pazaryeri çözümünde kullanılır)
(Pazaryeri çözümünde kullanılır)
HTTP Metod | URL |
---|---|
POST |
/onboarding/v1/members |
Yeni bir üye oluşturmak 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ü. Eğer üye satıcı ise gönderilmesi zorunludur. Bknz: Üye Tipleri |
memberExternalId |
string |
Evet | Üye dış ID değeri |
name |
string |
Hayır | Üye ismi. Eğer üye satıcı olup limited şirketi var ise gönderilmesi zorunludur. |
address |
string |
Evet | Üye adresi |
email |
string |
Evet | Üyeye ait email adresi |
iban |
string |
Hayır | Üye IBAN değeri. Eğer üye satıcı olup kazanç dağıtım yeri IBAN ise gönderilmesi zorunludur. Sadece TR iban gönderilmelidir. |
settlementEarningsDestination |
SettlementEarningsDestination |
Hayır | Üye kazançları dağıtım yeri. Eğer üye satıcı ise gönderilmesi zorunludur. Bknz: Para Gönderim Yerleri |
negativeWalletAmountLimit |
decimal |
Hayır | Üye cüzdanı için eksi bakiye alt limiti belirleyebilirsiniz. 0'dan küçük bir değer olmalıdır. |
phoneNumber |
string |
Evet | Üye telefon numarası |
legalCompanyTitle |
string |
Hayır | Resmi şirket ismi. Eğer üye satıcı olup sahış ve limited şirketi var ise gönderilmesi zorunludur. |
taxOffice |
string |
Hayır | Üye vergi dairesi. Eğer satıcının sahış ve limited şirketi var ise gönderilmesi zorunludur. |
taxNumber |
string |
Hayır | Üye vergi numarası. Eğer satıcının sahış ve limited şirketi var ise gönderilmesi zorunludur. |
contactName |
string |
Hayır | Üye ulaşılabilir kişi ismi. Eğer üye alıcı ise veya satıcı olup bireysel ve şahıs şirketi var ise gönderilmesi zorunludur. |
contactSurname |
string |
Hayır | Üye ulaşılabilir kişi soyismi. Eğer üye alıcı ise veya satıcı olup bireysel ve şahıs şirketi var ise gönderilmesi zorunludur. |
identityNumber |
string |
Hayır | Üye kimlik numarası |
Üye oluşturma 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 | 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 |
phoneNumber |
string |
Üye telefon numarası |
identityNumber |
string |
Kimlik numarası |
contactName |
string |
Üye ulaşılabilir kişi ismi |
contactSurname |
string |
Üye ulaşılabilir kişi soyismi |
legalCompanyTitle |
string |
Resmi şirket ismi |
taxOffice |
string |
Üye vergi dairesi |
taxNumber |
string |
Üye vergi no |
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 |
iban |
string |
Üyeye ait iban bilgisi |
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.