Ana içeriğe atla
GET
Müşteri firmalarını listeler

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı anahtar kimliği, parola secret key değeridir. Anahtar aktif olmalı, erişim bitiş tarihi geçmemiş olmalı ve BankaPro erişimine sahip olmalıdır. Firma anahtarında firma anahtardan sunucu tarafında belirlenir; istemciden firma kimliği alınmaz. Entegratör anahtarı firmayı yalnız /v1/companies/{companyId} adresinden alır ve yalnız kendi müşteri firmalarına erişir. Anahtarın IP kısıtı doluysa istek yalnız listedeki adreslerden kabul edilir. Kimlik bilgileri yalnız HTTPS üzerinden gönderilmelidir.

Başlıklar

x-request-id
string

Opsiyonel izleme kimliği. Değer 1-100 karakter ve yalnız harf, rakam, nokta, alt çizgi, iki nokta veya tire içeriyorsa korunur; aksi halde sunucu yeni bir UUID üretir.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._:-]{1,100}$

Sorgu Parametreleri

page
integer
varsayılan:1
Gerekli aralık: x >= 1
pageSize
integer
varsayılan:25
Gerekli aralık: 1 <= x <= 100
status
enum<string>

Firma durumuna göre süzer.

Mevcut seçenekler:
active,
passive
taxId
string

VKN (10 hane) veya TCKN (11 hane) ile tam eşleşme.

Pattern: ^\d{10,11}$

Yanıt

Müşteri firmaları

success
enum<boolean>
gerekli
Mevcut seçenekler:
true
meta
object
gerekli
data
object[]
gerekli