İçeriğe geç
Admin API

PaymentProxy

Serverhttps://magaza-adiniz.myideasoft.com

PaymentProxy LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/payment_proxies
Bearer
or
OAuth 2.0

Sistemdeki tüm PaymentProxy (ödeme aracı) kayıtlarını listeler. Filtreleme, sıralama ve sayfalama parametreleriyle sonuçlar özelleştirilebilir.

PaymentProxy LIST › query Parameters

sort
​string

Sonuçları belirli bir alana göre sıralamak için kullanılır. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek maksimum PaymentProxy sayısı.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağını belirtir. Sayfalama işlemleri için kullanılır.

Default: 1
id
​integer · min: 1

Tek bir PaymentProxy kaydını getirmek için kullanılacak id değeri.

ids
​string

Birden fazla PaymentProxy kaydını getirmek 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.

q
​string

Gelişmiş arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]=<aranan-değer>. Örnek: q[name]=iyzico.

s
​string

Genel arama anahtarı. Metin bazlı filtreleme yapmak için kullanılır.

PaymentProxy LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1

Ödeme yönlendiricisine ait özel ayarları içeren JSON nesnesi (ör. API anahtarı, endpoint bilgileri).

Example: {"apiKey":"abc123xyz","endpoint":"https://masterpass.com/api"}
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

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

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00

PaymentProxy COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/payment_proxies/count
Bearer
or
OAuth 2.0

Sistemdeki tüm PaymentProxy (ödeme aracı) kayıtlarını listeler. Filtreleme, sıralama ve sayfalama parametreleriyle sonuçlar özelleştirilebilir.

PaymentProxy COUNT › query Parameters

sort
​string

Sonuçları belirli bir alana göre sıralamak için kullanılır. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek maksimum PaymentProxy sayısı.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağını belirtir. Sayfalama işlemleri için kullanılır.

Default: 1
id
​integer · min: 1

Tek bir PaymentProxy kaydını getirmek için kullanılacak id değeri.

ids
​string

Birden fazla PaymentProxy kaydını getirmek 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.

q
​string

Gelişmiş arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]=<aranan-değer>. Örnek: q[name]=iyzico.

s
​string

Genel arama anahtarı. Metin bazlı filtreleme yapmak için kullanılır.

PaymentProxy COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


PaymentProxy GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/payment_proxies/{id}
Bearer
or
OAuth 2.0

PaymentProxy GET › path Parameters

id
​string · pattern: \d+ · required

PaymentProxy GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1

Ödeme yönlendiricisine ait özel ayarları içeren JSON nesnesi (ör. API anahtarı, endpoint bilgileri).

Example: {"apiKey":"abc123xyz","endpoint":"https://masterpass.com/api"}
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

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

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00

PaymentProxy PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/payment_proxies/{id}
Bearer
or
OAuth 2.0

PaymentProxy PUT › path Parameters

id
​string · pattern: \d+ · required

PaymentProxy PUT › Request Body

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1

Ödeme yönlendiricisine ait özel ayarları içeren JSON nesnesi (ör. API anahtarı, endpoint bilgileri).

Example: {"apiKey":"abc123xyz","endpoint":"https://masterpass.com/api"}
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

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

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00

PaymentProxy PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1

Ödeme yönlendiricisine ait özel ayarları içeren JSON nesnesi (ör. API anahtarı, endpoint bilgileri).

Example: {"apiKey":"abc123xyz","endpoint":"https://masterpass.com/api"}
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

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

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00