Skip to content
Ideasoft
Admin API

Payment

Serverhttps://your-store.myideasoft.com

Payment LIST

GET
https://your-store.myideasoft.com
/admin-api/payments
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki ödeme kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), tarih aralığı (startCreatedAt, endCreatedAt), durum (status), cihaz türü (deviceType), para birimi (filterCurrency), fiyat aralığı (minPrice, maxPrice) ve diğer parametrelerle özelleştirilebilir.

Payment LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,amount

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Payment sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Tek bir Payment kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Payment kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

transactionId
​string

Belirli bir Transaction (işlem) ID’sine ait ödemeleri filtreler. Örnek: transactionId=TXN123456

memberFullName
​string

Üye tam adına göre filtreleme yapar. Örnek: memberFullName=Ömer ŞAHİN

memberGroup
​integer · min: -1

Üyenin ait olduğu grup kimliğine göre filtreleme yapar. Örnek: memberGroup=5

status
​string · enum

Payment durumuna göre filtreleme yapar. Aşağıdaki değerleri alabilir: - waiting_for_approval - approved - fulfilled - cancelled - delivered - on_accumulation - waiting_for_payment - being_prepared - refunded - personal_status_1, personal_status_2, personal_status_3 - deleted, failed, in_transaction Örnek: status=approved

Enum values:
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
being_prepared
startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt (oluşturulma tarihi) için başlangıç tarih filtresi. Örnek: startCreatedAt=2025-01-01

member
​integer · min: 1

Üye kimliğine göre filtreleme yapar. Örnek: member=42

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt (oluşturulma tarihi) için bitiş tarih filtresi. Örnek: endCreatedAt=2025-12-31

deviceType
​string · enum

Ödeme işlemini yapan cihaz türüne göre filtreleme yapar. Desteklenen değerler: - mobile - desktop Örnek: deviceType=mobile

Enum values:
mobile
desktop
gatewayCode
​string · enum

Kullanılan ödeme sağlayıcısına göre filtreleme yapar. Desteklenen gateway kodları: anadolubank, axess, bonus_card, cardfinans, denizbank_bonus, halkbank_paraf, hsbc_advantage_kart, ing_bank, kuveyt_turk_kredi_karti, maximum_kart, param_card, t_finans_kredi_karti, teb, vakifbank_worldcard, world_card, ziraat_maximum Örnek: gatewayCode=axess

Enum values:
anadolubank
axess
bonus_card
cardfinans
denizbank_bonus
halkbank_paraf
hsbc_advantage_kart
ing_bank
filterCurrency
​string · enum

Para birimi filtresi. Numeric olarak tanımlanır. Örnek: filterCurrency=1

Enum values:
1
2
3
4
5
6
7
8
minPrice
​string

Belirtilen minimum tutardan büyük ödemeleri getirir. Örnek: minPrice=100

maxPrice
​string

Belirtilen maksimum tutardan küçük ödemeleri getirir. Örnek: maxPrice=1000

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=değer Örnek: q[status]=approved

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Bu parametre, ödeme kayıtlarının çeşitli alanlarında eşleşme arar.

Payment LIST › Responses

The request (GET or PUT) completed successfully.

Ödeme işlemi detay objesi
transactionId
​string · maxLength: 255 · required

İşlem numarası

Example: 152502357
memberFirstname
​string · maxLength: 255 · required

Ödeme yapan üyenin adı

Example: Ahmet
memberSurname
​string · maxLength: 255 · required

Ödeme yapan üyenin soyadı

Example: Yılmaz
memberEmail
​string · email · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
memberPhone
​string · maxLength: 255 · required

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
paymentTypeName
​string · maxLength: 255 · required

Ödeme yöntemi adı

Example: Kredi Kartı
paymentProviderCode
​string · maxLength: 255 · required

Ödeme sağlayıcı kodu

Example: IdeaPay
paymentProviderName
​string · maxLength: 255 · required

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayCode
​string · maxLength: 255 · required

Ödeme gateway kodu

Example: ideacard
paymentGatewayName
​string · maxLength: 255 · required

Ödeme gateway adı

Example: IdeaCard
bankName
​string · maxLength: 64 · required

İşlem yapılan banka adı

Example: Idea Bank
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
currencyRates
​string · maxLength: 255 · required

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0 · required

Ödeme tutarı (vergi ve indirimler hariç)

Example: 100
finalAmount
​number · decimal · min: 0 · required

Toplam ödeme tutarı (tüm hesaplamalarla birlikte)

Example: 118
installment
​integer · min: 0 · max: 12 · required

Taksit sayısı

Example: 3
installmentRate
​number · decimal · required

Taksit oranı (faiz oranı)

Example: 1.05
currency
​string · maxLength: 32 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Ödeme için benzersiz kimlik

Example: 123
statusLang
​string

Sipariş durumu yerelleştirilmiş metni

Example: Onaylandı
cardHolderName
​string · maxLength: 64

Kart sahibinin adı

Example: AHMET YILMAZ
sumOfGainedPoints
​number · decimal · min: 0

Bu ödemeden kazanılan toplam puan

Example: 100
extraInstallment
​integer · min: 0 · max: 12

Ekstra kampanya taksit sayısı

Example: 0
memberNote
​string

Müşteri tarafından eklenen sipariş notu

Example: Her ayın ikisinde teslimat istiyorum
userNote
​string

Yönetici tarafından eklenen sipariş notu

Example: Her ayın ikisinde gönderilecek
errorMessage
​string

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string

Kullanılan kart saklama sistemi

Example: ideasave
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
clientIp
​string · ipv4

Müşterinin IP adresi

Example: 192.168.1.1

Payment COUNT

GET
https://your-store.myideasoft.com
/admin-api/payments/count
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki ödeme kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), tarih aralığı (startCreatedAt, endCreatedAt), durum (status), cihaz türü (deviceType), para birimi (filterCurrency), fiyat aralığı (minPrice, maxPrice) ve diğer parametrelerle özelleştirilebilir.

Payment COUNT › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,amount

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Payment sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Tek bir Payment kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Payment kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

transactionId
​string

Belirli bir Transaction (işlem) ID’sine ait ödemeleri filtreler. Örnek: transactionId=TXN123456

memberFullName
​string

Üye tam adına göre filtreleme yapar. Örnek: memberFullName=Ömer ŞAHİN

memberGroup
​integer · min: -1

Üyenin ait olduğu grup kimliğine göre filtreleme yapar. Örnek: memberGroup=5

status
​string · enum

Payment durumuna göre filtreleme yapar. Aşağıdaki değerleri alabilir: - waiting_for_approval - approved - fulfilled - cancelled - delivered - on_accumulation - waiting_for_payment - being_prepared - refunded - personal_status_1, personal_status_2, personal_status_3 - deleted, failed, in_transaction Örnek: status=approved

Enum values:
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
being_prepared
startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt (oluşturulma tarihi) için başlangıç tarih filtresi. Örnek: startCreatedAt=2025-01-01

member
​integer · min: 1

Üye kimliğine göre filtreleme yapar. Örnek: member=42

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt (oluşturulma tarihi) için bitiş tarih filtresi. Örnek: endCreatedAt=2025-12-31

deviceType
​string · enum

Ödeme işlemini yapan cihaz türüne göre filtreleme yapar. Desteklenen değerler: - mobile - desktop Örnek: deviceType=mobile

Enum values:
mobile
desktop
gatewayCode
​string · enum

Kullanılan ödeme sağlayıcısına göre filtreleme yapar. Desteklenen gateway kodları: anadolubank, axess, bonus_card, cardfinans, denizbank_bonus, halkbank_paraf, hsbc_advantage_kart, ing_bank, kuveyt_turk_kredi_karti, maximum_kart, param_card, t_finans_kredi_karti, teb, vakifbank_worldcard, world_card, ziraat_maximum Örnek: gatewayCode=axess

Enum values:
anadolubank
axess
bonus_card
cardfinans
denizbank_bonus
halkbank_paraf
hsbc_advantage_kart
ing_bank
filterCurrency
​string · enum

Para birimi filtresi. Numeric olarak tanımlanır. Örnek: filterCurrency=1

Enum values:
1
2
3
4
5
6
7
8
minPrice
​string

Belirtilen minimum tutardan büyük ödemeleri getirir. Örnek: minPrice=100

maxPrice
​string

Belirtilen maksimum tutardan küçük ödemeleri getirir. Örnek: maxPrice=1000

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=değer Örnek: q[status]=approved

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Bu parametre, ödeme kayıtlarının çeşitli alanlarında eşleşme arar.

Payment COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Payment GET

GET
https://your-store.myideasoft.com
/admin-api/payments/{id}
Bearer
or
OAuth 2.0

Payment GET › path Parameters

id
​string · pattern: \d+ · required

Payment GET › Responses

The request (GET or PUT) completed successfully.

Ödeme işlemi detay objesi
transactionId
​string · maxLength: 255 · required

İşlem numarası

Example: 152502357
memberFirstname
​string · maxLength: 255 · required

Ödeme yapan üyenin adı

Example: Ahmet
memberSurname
​string · maxLength: 255 · required

Ödeme yapan üyenin soyadı

Example: Yılmaz
memberEmail
​string · email · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
memberPhone
​string · maxLength: 255 · required

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
paymentTypeName
​string · maxLength: 255 · required

Ödeme yöntemi adı

Example: Kredi Kartı
paymentProviderCode
​string · maxLength: 255 · required

Ödeme sağlayıcı kodu

Example: IdeaPay
paymentProviderName
​string · maxLength: 255 · required

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayCode
​string · maxLength: 255 · required

Ödeme gateway kodu

Example: ideacard
paymentGatewayName
​string · maxLength: 255 · required

Ödeme gateway adı

Example: IdeaCard
bankName
​string · maxLength: 64 · required

İşlem yapılan banka adı

Example: Idea Bank
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
currencyRates
​string · maxLength: 255 · required

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0 · required

Ödeme tutarı (vergi ve indirimler hariç)

Example: 100
finalAmount
​number · decimal · min: 0 · required

Toplam ödeme tutarı (tüm hesaplamalarla birlikte)

Example: 118
installment
​integer · min: 0 · max: 12 · required

Taksit sayısı

Example: 3
installmentRate
​number · decimal · required

Taksit oranı (faiz oranı)

Example: 1.05
currency
​string · maxLength: 32 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Ödeme için benzersiz kimlik

Example: 123
statusLang
​string

Sipariş durumu yerelleştirilmiş metni

Example: Onaylandı
cardHolderName
​string · maxLength: 64

Kart sahibinin adı

Example: AHMET YILMAZ
sumOfGainedPoints
​number · decimal · min: 0

Bu ödemeden kazanılan toplam puan

Example: 100
extraInstallment
​integer · min: 0 · max: 12

Ekstra kampanya taksit sayısı

Example: 0
memberNote
​string

Müşteri tarafından eklenen sipariş notu

Example: Her ayın ikisinde teslimat istiyorum
userNote
​string

Yönetici tarafından eklenen sipariş notu

Example: Her ayın ikisinde gönderilecek
errorMessage
​string

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string

Kullanılan kart saklama sistemi

Example: ideasave
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
clientIp
​string · ipv4

Müşterinin IP adresi

Example: 192.168.1.1

Payment PUT

PUT
https://your-store.myideasoft.com
/admin-api/payments/{id}
Bearer
or
OAuth 2.0

Payment PUT › path Parameters

id
​string · pattern: \d+ · required

Payment PUT › Request Body

Ödeme işlemi detay objesi
transactionId
​string · maxLength: 255 · required

İşlem numarası

Example: 152502357
memberFirstname
​string · maxLength: 255 · required

Ödeme yapan üyenin adı

Example: Ahmet
memberSurname
​string · maxLength: 255 · required

Ödeme yapan üyenin soyadı

Example: Yılmaz
memberEmail
​string · email · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
memberPhone
​string · maxLength: 255 · required

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
paymentTypeName
​string · maxLength: 255 · required

Ödeme yöntemi adı

Example: Kredi Kartı
paymentProviderCode
​string · maxLength: 255 · required

Ödeme sağlayıcı kodu

Example: IdeaPay
paymentProviderName
​string · maxLength: 255 · required

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayCode
​string · maxLength: 255 · required

Ödeme gateway kodu

Example: ideacard
paymentGatewayName
​string · maxLength: 255 · required

Ödeme gateway adı

Example: IdeaCard
bankName
​string · maxLength: 64 · required

İşlem yapılan banka adı

Example: Idea Bank
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
currencyRates
​string · maxLength: 255 · required

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0 · required

Ödeme tutarı (vergi ve indirimler hariç)

Example: 100
finalAmount
​number · decimal · min: 0 · required

Toplam ödeme tutarı (tüm hesaplamalarla birlikte)

Example: 118
installment
​integer · min: 0 · max: 12 · required

Taksit sayısı

Example: 3
installmentRate
​number · decimal · required

Taksit oranı (faiz oranı)

Example: 1.05
currency
​string · maxLength: 32 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Ödeme için benzersiz kimlik

Example: 123
statusLang
​string

Sipariş durumu yerelleştirilmiş metni

Example: Onaylandı
cardHolderName
​string · maxLength: 64

Kart sahibinin adı

Example: AHMET YILMAZ
sumOfGainedPoints
​number · decimal · min: 0

Bu ödemeden kazanılan toplam puan

Example: 100
extraInstallment
​integer · min: 0 · max: 12

Ekstra kampanya taksit sayısı

Example: 0
memberNote
​string

Müşteri tarafından eklenen sipariş notu

Example: Her ayın ikisinde teslimat istiyorum
userNote
​string

Yönetici tarafından eklenen sipariş notu

Example: Her ayın ikisinde gönderilecek
errorMessage
​string

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string

Kullanılan kart saklama sistemi

Example: ideasave
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
clientIp
​string · ipv4

Müşterinin IP adresi

Example: 192.168.1.1

Payment PUT › Responses

The request (GET or PUT) completed successfully.

Ödeme işlemi detay objesi
transactionId
​string · maxLength: 255 · required

İşlem numarası

Example: 152502357
memberFirstname
​string · maxLength: 255 · required

Ödeme yapan üyenin adı

Example: Ahmet
memberSurname
​string · maxLength: 255 · required

Ödeme yapan üyenin soyadı

Example: Yılmaz
memberEmail
​string · email · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
memberPhone
​string · maxLength: 255 · required

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
paymentTypeName
​string · maxLength: 255 · required

Ödeme yöntemi adı

Example: Kredi Kartı
paymentProviderCode
​string · maxLength: 255 · required

Ödeme sağlayıcı kodu

Example: IdeaPay
paymentProviderName
​string · maxLength: 255 · required

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayCode
​string · maxLength: 255 · required

Ödeme gateway kodu

Example: ideacard
paymentGatewayName
​string · maxLength: 255 · required

Ödeme gateway adı

Example: IdeaCard
bankName
​string · maxLength: 64 · required

İşlem yapılan banka adı

Example: Idea Bank
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
currencyRates
​string · maxLength: 255 · required

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0 · required

Ödeme tutarı (vergi ve indirimler hariç)

Example: 100
finalAmount
​number · decimal · min: 0 · required

Toplam ödeme tutarı (tüm hesaplamalarla birlikte)

Example: 118
installment
​integer · min: 0 · max: 12 · required

Taksit sayısı

Example: 3
installmentRate
​number · decimal · required

Taksit oranı (faiz oranı)

Example: 1.05
currency
​string · maxLength: 32 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Ödeme için benzersiz kimlik

Example: 123
statusLang
​string

Sipariş durumu yerelleştirilmiş metni

Example: Onaylandı
cardHolderName
​string · maxLength: 64

Kart sahibinin adı

Example: AHMET YILMAZ
sumOfGainedPoints
​number · decimal · min: 0

Bu ödemeden kazanılan toplam puan

Example: 100
extraInstallment
​integer · min: 0 · max: 12

Ekstra kampanya taksit sayısı

Example: 0
memberNote
​string

Müşteri tarafından eklenen sipariş notu

Example: Her ayın ikisinde teslimat istiyorum
userNote
​string

Yönetici tarafından eklenen sipariş notu

Example: Her ayın ikisinde gönderilecek
errorMessage
​string

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string

Kullanılan kart saklama sistemi

Example: ideasave
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
clientIp
​string · ipv4

Müşterinin IP adresi

Example: 192.168.1.1

Payment DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/payments/{id}
Bearer
or
OAuth 2.0

Payment DELETE › path Parameters

id
​string · pattern: \d+ · required

Payment DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned