İçeriğe geç
Admin API

PaymentGatewaySetting

Serverhttps://magaza-adiniz.myideasoft.com

PaymentGatewaySetting LIST

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

Bu endpoint, sistemde tanımlı tüm ödeme altyapısı (payment gateway) ayarlarını listelemek veya filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), ödeme sağlayıcısı (paymentGateway, paymentGatewayCode) ve arama (q, s) parametreleriyle özelleştirilebilir.

PaymentGatewaySetting LIST › query Parameters

sort
​string

Sonuçların sıralanma biçimini belirtir. - Artan sıra için: sort=id - Azalan sıra için: sort=-id Birden fazla alanla sıralamak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

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

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Payment Gateway Setting (ödeme altyapısı ayarı) kaydını döndürür. Örnek: id=7

paymentGateway
​integer · min: -1

Belirli bir ödeme sağlayıcısına (Payment Provider) ait ayarları döndürür. Genellikle provider ID ile sorgulanır. Örnek: paymentGateway=2

paymentGatewayCode
​string

Ödeme altyapısının sistemdeki benzersiz kod değerine göre filtreleme yapar. Örnek: paymentGatewayCode=iyzico veya paymentGatewayCode=stripe

q
​string

Alan bazlı detaylı arama filtresi. q parametresi, belirli alanlarda arama yapmanızı sağlar. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Iyzico veya q[status]=active

s
​string

Genel arama anahtarı. Bu parametre, sistemde tanımlı tüm metinsel alanlarda eşleşme arar. Örnek: s=stripe

PaymentGatewaySetting LIST › Responses

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

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/payment_gateway_settings
Bearer
or
OAuth 2.0

PaymentGatewaySetting POST › Request Body

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting COUNT

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

Bu endpoint, sistemde tanımlı tüm ödeme altyapısı (payment gateway) ayarlarını listelemek veya filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), ödeme sağlayıcısı (paymentGateway, paymentGatewayCode) ve arama (q, s) parametreleriyle özelleştirilebilir.

PaymentGatewaySetting COUNT › query Parameters

sort
​string

Sonuçların sıralanma biçimini belirtir. - Artan sıra için: sort=id - Azalan sıra için: sort=-id Birden fazla alanla sıralamak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

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

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Payment Gateway Setting (ödeme altyapısı ayarı) kaydını döndürür. Örnek: id=7

paymentGateway
​integer · min: -1

Belirli bir ödeme sağlayıcısına (Payment Provider) ait ayarları döndürür. Genellikle provider ID ile sorgulanır. Örnek: paymentGateway=2

paymentGatewayCode
​string

Ödeme altyapısının sistemdeki benzersiz kod değerine göre filtreleme yapar. Örnek: paymentGatewayCode=iyzico veya paymentGatewayCode=stripe

q
​string

Alan bazlı detaylı arama filtresi. q parametresi, belirli alanlarda arama yapmanızı sağlar. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Iyzico veya q[status]=active

s
​string

Genel arama anahtarı. Bu parametre, sistemde tanımlı tüm metinsel alanlarda eşleşme arar. Örnek: s=stripe

PaymentGatewaySetting 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ı.


PaymentGatewaySetting GET

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

PaymentGatewaySetting GET › path Parameters

id
​string · pattern: \d+ · required

PaymentGatewaySetting GET › Responses

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

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting PUT

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

PaymentGatewaySetting PUT › path Parameters

id
​string · pattern: \d+ · required

PaymentGatewaySetting PUT › Request Body

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting PUT › Responses

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

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGatewaySetting DELETE

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

PaymentGatewaySetting DELETE › path Parameters

id
​string · pattern: \d+ · required

PaymentGatewaySetting DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned