Merchant Listesi

Kayıtlı üye işyeri listesini almak için kullanılan servistir. Paging yapısı desteklenmektedir. Bu serviste istek yapabilmesi için token bilgisinin Header'da gönderilmesi gerekmektedir. Bu linkten Üye İşyeri Doğrulama token bilgilerine ulaşabilirsiniz

Servise gönderilmesi gereken parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Zorunluluk Örnek Değer Açıklama
parentMerchantId long 16 Evet 27 Sizin için oluşturulan Üye işyeri ID'si
identityNumber String 12 Hayır 12345678912 TC kimlik numarası filtreleme. Dolu gönderilmesi halinde bu kimlik numarasına ait üye işyeri bilgisi döner
taxNumber String 20 Hayır 1700000021 Vergi numarası filtreleme. Dolu gönderilmesi halinde bu vergi numarasına ait üye işyeri bilgisi döner
pageOptions Paging kontrollerinin yapıldığı sınıftır.
page int - Evet 1 Listelenmesi istenen sayfa numarası
pageSize int - Evet 20 Bir sayfada listelenecek işlem adedi
sortOrder String 4 Evet Asc, Desc Bir sayfada listelenecek işlem adedir. sortField'da yazılacak bilgiye göre sıralı listelenmesi için "Asc" , tersten sıralanması için "Desc" yazılmalıdır.
sortField String 35 Evet 1 Sıralanması istenen alan adı. Oluşturulma tarihine göre sıralalanması için "StartDate" girilebilir.
Servisten dönen parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Açıklama
merchantStatus string 20 Üye işyeri durumu. ACTIVE --> Aktif, PASSIVE --> Pasif
name string 100 Üye işyeri adı
forceNonsecureAddCard boolean - Üye işyerina ait işlemler 3D Secure zorunluluk belirteci. "true": 3D Secure zorunlu, "false": 3D Secure zorunlu değil.
onusActive boolean - Banka yönlendirme on-us durumu. (Şimdilik kullanılmamaktadır)
useApi boolean - Api kullanma yetkisi. "true": Api kullanabilir, "false": Api kullanamaz.
merchantNumber string 255 Üye işyeri numarası
bkmMerchantId integer - BKM üye işyeri ID
mcc string 100 Üye işyeri katagori kodu
namePlate string 100 Üye işyeri tabela adı
identityNumber string 12 Üye işyeri kimlik numarası
taxNumber string 10 Üye işyeri vergi numarası
address string 256 Üye işyeri adresi
town string 100 Üye işyeri adresi ilçe bilgisi
city string 100 Üye işyeri adresi şehir bilgisi
postCode string 100 Üye işyeri adresi posta kodu
phoneNumber string 20 Üye işyeri adresi telefonu
email string 100 Üye işyeri e-posta adresi
webAddress string 256 Üye işyeri web adresi
contractDate int 4 Üye işyeri sözleşme tarihi. (YYYYMMDD formatında)
startDate int 4 Üye işyeri geçerlilik başlangıç tarihi. (YYYYMMDD formatında)
finishDate int 4 Üye işyeri geçerlilik bitiş tarihi. (YYYYMMDD formatında)
ownerName string 100 Üye işyeri yetkilisi
parentMerchantId int - Üye işyerinin bağlı olduğu ana iş yeri Id si
firmId string 9 Üye işyeri Firma ID si
nonesecureMaxAmount decimal (15,2) NonSecure işlem üst tutar limit bilgisi
channel string 10 Kanal bilgisi
merchantPassword string 30 Üye işyeri şifre bilgisi. (Şimdilik kullanılmamaktadır.)
avoidAddCard boolean - Üye işyeri art saklama yetkisi. "true" : Kart saklama yetkisi yok. "false" : Kart saklama yetkisi var.
Örnek JSON formatında istek ve cevaplar aşağıdadır:

HTTP Method: POST

Content-Type: application/json

TEST URL: https://ppgpayment-test.birlesikodeme.com:20000/api/ppg/Payment/GetMerchantList

PROD URL: https://{baseUrl}/api/ppg/Payment/GetMerchantList

*Prod için baseUrl adresi, size entegrasyon mailinde "paymentBaseUrl" alanında iletilecektir.

Request
{
  "parentMerchantId": 0,
  "identityNumber": "string",
  "taxNumber": "string",
  "pageOptions": {
    "page": 0,
    "pageSize": 0,
    "sortOrder": "string",
    "sortField": "string"
  }
}
Response

{
  "fail": false,
  "statusCode": 200,
  "result": {
    "page": 1,
    "pageSize": 50,
    "totalPage": 1,
    "totalCount": 8,
    "data": [
      {
        "merchantStatus": "ACTIVE",
        "name": "MAHMUT BALCI",
        "forceNonsecureAddCard": false,
        "onusActive": true,
        "useApi": true,
        "merchantNumber": "125",
        "bkmMerchantId": 88888888,
        "mcc": "1750",
        "namePlate": ""ACTIVE",
        "name": "MAHMUT BALCI AŞ",
        "identityNumber": "30988866008",
        "taxNumber": "1780711821",
        "address": "MAYA AKAR CENTER KAT 3MAYA AKAR CENTER KAT 3",
        "town": "MECİDİYEKÖY",
        "city": "İSTANBUL",
        "postCode": "34394",
        "phoneNumber": "",
        "email": null,
        "webAddress": "www.mahmutbalci.org",
        "contractDate": 20210329,
        "startDate": 20210330,
        "finishDate": 99991231,
        "ownerName": ""ACTIVE",
        "name": "MAHMUT BALCI",
        "parentMerchantId": 27,
        "firmId": "428",
        "nonesecureMaxAmount": 0,
        "channel": "API",
        "merchantPassword": null,
        "avoidAddCard": false
      },
      .....
      ]
      }
}