Kullanıcı Servisleri

Ödeme akışına dahil edilecek kullanıcıları bu servis grubu üzerinden yönetirsiniz. Yeni bir kullanıcı oluşturabilir, sistemden silebilir ya da mevcut kullanıcıları sayfalanmış şekilde listeleyebilirsiniz. Her kullanıcı, bağlı olduğu banka ve terminal bilgilerini (enrollment) taşır; bu bilgiler ödeme başlatma adımında otomatik olarak kullanılır.

Kullanıcı Ekleme

post

https://sandbox-api.iyzipay.com/v3/in-storehttps://api.iyzipay.com/v3/in-store

/user

Yeni bir kullanıcı oluşturur ve kullanıcı bilgilerini döner.

Header parameters

x-api-keystringRequired

iyzico panelinizdeki CepPOS API anahtarı

Example: YOUR_API_KEY

x-secret-keystringRequired

iyzico panelinizdeki CepPOS güvenlik anahtarı

Example: YOUR_SECRET_KEY

x-merchant-idstringRequired

iyzico hesabınızın üye işyeri numarası

Example: YOUR_MERCHANT_ID

Body

application/json

userIdstringRequired

Kullanıcı kimliği

Example: user-123

Responses

200

Kullanıcı başarıyla oluşturuldu

application/json

statusstringOptional

İşlemin sonucunu gösterir. Hata durumunda her zaman "failure" döner.

Example: failure

systemTimeinteger · int64Optional

Sunucu tarafındaki işlem zamanı (Unix epoch, milisaniye).

Example: 1750291200000

userIdstringOptional

Sisteme kayıtlı kullanıcının benzersiz kimliği.

Example: user-001

400

Geçersiz parametre veya eksik alan

application/json

401

Geçersiz veya eksik header

application/json

500

Sunucu hatası

application/json

post/user

HTTPcURLJavaScriptPython

POST /v3/in-store/user HTTP/1.1
Host: sandbox-api.iyzipay.com
x-api-key: YOUR_API_KEY
x-secret-key: YOUR_SECRET_KEY
x-merchant-id: YOUR_MERCHANT_ID
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "userId": "user-123"
}

{
  "userId": "user-001",
  "enrollments": [
    {
      "enrolledBank": "AKBANK",
      "enrolledTerminalId": "123123",
      "enrollmentStatus": "ENROLLED_TERMINAL"
    },
    {
      "enrolledBank": "ISBANK",
      "enrolledTerminalId": "456456",
      "enrollmentStatus": "ENROLLED_TERMINAL"
    }
  ]
}

Kullanıcı Silme

delete

https://sandbox-api.iyzipay.com/v3/in-storehttps://api.iyzipay.com/v3/in-store

/user

Var olan bir kullanıcıyı sistemden siler.

Header parameters

x-api-keystringRequired

iyzico panelinizdeki CepPOS API anahtarı

Example: YOUR_API_KEY

x-secret-keystringRequired

iyzico panelinizdeki CepPOS güvenlik anahtarı

Example: YOUR_SECRET_KEY

x-merchant-idstringRequired

iyzico hesabınızın üye işyeri numarası

Example: YOUR_MERCHANT_ID

Body

application/json

statusstringOptional

İşlemin sonucunu gösterir. Hata durumunda her zaman "failure" döner.

Example: failure

systemTimeinteger · int64Optional

Sunucu tarafındaki işlem zamanı (Unix epoch, milisaniye).

Example: 1750291200000

userIdstringRequired

Silinecek kullanıcı kimliği

Example: user-123

Responses

200

Kullanıcı başarıyla silindi

application/json

userIdstringOptional

Başarıyla silinen kullanıcının kimliği. Silme işleminin doğrulanması amacıyla döner.

Example: user-123

400

Geçersiz parametre veya eksik alan

application/json

401

Geçersiz veya eksik header

application/json

500

Sunucu hatası

application/json

delete/user

HTTPcURLJavaScriptPython

DELETE /v3/in-store/user HTTP/1.1
Host: sandbox-api.iyzipay.com
x-api-key: YOUR_API_KEY
x-secret-key: YOUR_SECRET_KEY
x-merchant-id: YOUR_MERCHANT_ID
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "userId": "user-123"
}

{
  "status": "success",
  "systemTime": 1783083211097,
  "userId": "user-123"
}

Kullanıcı Listeleme

get

https://sandbox-api.iyzipay.com/v3/in-storehttps://api.iyzipay.com/v3/in-store

/user/list

Sistemdeki kullanıcıların sayfalanmış (paginated) listesini döner.

Query parameters

pageNumberintegerOptional

Sayfa numarası

Default: 1Example: 1

pageCountintegerOptional

Sayfa başına kullanıcı sayısı

Default: 100Example: 100

Header parameters

x-api-keystringRequired

iyzico panelinizdeki CepPOS API anahtarı

Example: YOUR_API_KEY

x-secret-keystringRequired

iyzico panelinizdeki CepPOS güvenlik anahtarı

Example: YOUR_SECRET_KEY

x-merchant-idstringRequired

iyzico hesabınızın üye işyeri numarası

Example: YOUR_MERCHANT_ID

Responses

200

Başarılı — kullanıcı listesi döner

application/json

statusstringOptional

İşlemin sonucunu gösterir. Hata durumunda her zaman "failure" döner.

Example: failure

systemTimeinteger · int64Optional

Sunucu tarafındaki işlem zamanı (Unix epoch, milisaniye).

Example: 1750291200000

400

Geçersiz parametre veya eksik alan

application/json

401

Geçersiz veya eksik header

application/json

500

Sunucu hatası

application/json

get/user/list

HTTPcURLJavaScriptPython

GET /v3/in-store/user/list HTTP/1.1
Host: sandbox-api.iyzipay.com
x-api-key: YOUR_API_KEY
x-secret-key: YOUR_SECRET_KEY
x-merchant-id: YOUR_MERCHANT_ID
Accept: */*

{
  "status": "success",
  "systemTime": 1783083211097,
  "userList": [
    {
      "userId": "user-001",
      "enrollments": [
        {
          "enrolledBank": "AKBANK",
          "enrolledTerminalId": "123123",
          "enrollmentStatus": "ENROLLED_TERMINAL"
        },
        {
          "enrolledBank": "ISBANK",
          "enrolledTerminalId": "456456",
          "enrollmentStatus": "ENROLLED_TERMINAL"
        }
      ]
    },
    {
      "userId": "user-002",
      "enrollments": [
        {
          "enrolledBank": "AKBANK",
          "enrolledTerminalId": "123123",
          "enrollmentStatus": "ENROLLED_TERMINAL"
        }
      ]
    }
  ]
}