URL

Alıcı güncellemek için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL URL Parametreleri
PUT /onboarding/v1/buyers/:id id: Alıcı ID değeri

İstek Parametreleri

Varolan bir alıcıyı güncellemek için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir. Alıcı güncelleme isteği diğer güncelleme isteklerine benzer olarak güncelleme isteği içerisinde olan her alanı günceller. Bu nedenle güncellenmesi istenmeyen değerler alıcının varolan değerleri ile doldurulmalıdır.

Parametre Adı Tipi Zorunlu Açıklama
email string Evet Alıcı ismi
name string Evet Alıcı soyismi
surname string Evet Alıcıya ait telefon numarası
identityNumber string Evet Alıcıya ait kimlik numarası
gsmNumber string Evet Alıcıya ait external ID değeri

Dönüş Parametreleri

Alıcı güncelleme 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.

Örnek Kodlar

Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz