Kampanya Listesi

Bu servis ile şirketinizin aktif kampanyalarını görüntüleyebilirsiniz.
user_mapping_id parametresi opsiyoneldir. Gönderildiğinde, kullanıcının kampanyaları kullanıp kullanmadığı bilgisi de döner.
user_mapping_id parametresi gönderildiğinde, kullanıcının daha önce kullandığı onboarding kampanyaları varsa listede görünmez.

Enum Değerleri Ve Açıklamaları

`campaign_types` (Kampanya Türü)

Enum Değeri	Açıklama
`deposit_gift`	Yüklemeye Puan
`payment_count_gift`	Harcama Sayısına Puan
`cross_marketing_deposit_gift`	Çapraz Satış Yüklemeye Puan
`payment_discount`	Harcamaya İndirim

`point_earn_type` (Puan Kazanma Türü)

Enum Değeri	Açıklama
`fixed`	Tutar Bazlı
`percentage`	Oran Bazlı

`point_earn_type` Alanlarına Göre Sıfır Değerler

point_earn_type	point_amount	point_percent
`fixed`	Değer döner	0 döner
`percentage`	0 döner	Değer döner

Kampanya Türlerine Göre Alan Kullanımı

Kampanya Türü	point_earn_type	amount	point_amount	point_percent	process_count	minimum_amount	maximum_amount
`deposit_gift`	fixed/percentage	✅	✅	✅	❌	❌	❌
`payment_count_gift`	fixed/percentage	❌	✅	✅	✅	✅	❌
`cross_marketing_deposit_gift`	fixed	✅	✅	❌	❌	❌	❌
`payment_discount`	percentage	❌	❌	✅	❌	✅	✅

Boolean Alanlar

Alan	Açıklama
`multiple_usage`	Çoklu Kullanım: Aynı kampanya aynı kullanıcı için birden fazla kez kullanılabilir
`include_multiples`	Katlarını Dahil Et (point_earn_type=fixed olduğunda): Yükleme tutarının katlarına da puan kazanılabilir
`combined_usage`	Diğer Kampanyalarla Kullanım: Diğer kampanyalarla birlikte kullanılabilir
`onboarding`	Onboarding Kampanyası: Yeni kayıt olan kullanıcılar için kullanılabilir kampanya

Tarih Alanları

Alan	Açıklama
`point_expire_date`	Puan son kullanma tarihi (sabit tarih seçildiğinde)
`expiration_days`	Puan geçerlilik gün sayısı (gün bazlı seçildiğinde)
`calculated_expiration_date`	Hesaplanan puan son kullanma tarihi (point_expire_date varsa onu, yoksa expiration_days kadar gün ekleyerek hesaplanan tarihi)

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

user_mapping_id?string

Kullanıcı oluşturma veya linkleme aşamasında size iletilen ilgili kullanıcıya ait linkleme id değeri.

Formatuuid

campaign_types?array<string>

Kampanya türü filtresi

Response Body

`application/json`

curl -X GET "https://api.altpay.dev/waas/integration/campaigns/list"

{
  "data": [
    {
      "id": 1,
      "name": "Yaz Tatili Fırsatı",
      "description": "Yaz tatiline özel ekstra puan kazanın!",
      "type": "deposit_gift",
      "point_earn_type": "percentage",
      "user_used": false,
      "amount": 100,
      "point_amount": 5,
      "point_percent": 5,
      "minimum_amount": 50,
      "maximum_amount": 500,
      "process_count": 5,
      "usage_limit": 1000,
      "total_usage": 150,
      "multiple_usage": true,
      "include_multiples": false,
      "combined_usage": true,
      "onboarding": false,
      "start_date": "2024-01-01T00:00:00+03:00",
      "end_date": "2024-12-31T23:59:59+03:00",
      "point_expire_date": "2025-01-15T23:59:59+03:00",
      "expiration_days": 30,
      "calculated_expiration_date": "2025-01-15T23:59:59+03:00"
    }
  ],
  "meta": {
    "paginate": {
      "per_page": 20,
      "current_page": 1,
      "has_more": true
    }
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "İşlemi yapmak için yetkili değilsiniz."
}

{
  "message": "string"
}

{
  "message": "Gönderdiğiniz Veriler Geçersiz",
  "errors": {
    "property": [
      "Hata açıklaması"
    ]
  }
}

200application/json

401application/json

403application/json

404application/json

422application/json

Bu sayfada

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`