URL

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

HTTP Metod URL
POST /onboarding/v1/buyers

İstek Parametreleri

Yeni bir alıcı 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
email string Evet Alıcıya ait email bilgisi
name string Evet Alıcı ismi
surname string Evet Alıcı soyismi
gsmNumber string Evet Alıcıya ait telefon numarası
identityNumber string Evet Alıcıya ait kimlik numarası
buyerExternalId string Evet Alıcıya ait external ID değeri

Dönüş Parametreleri

Alıcı yaratma 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 Status 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. Alıcı yaratma işlemi sonrası yaratılan alıcı her zaman ACTIVE statüdedir.

Örnek Kodlar

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