İçeriğe geç
Admin API

PaymentGateway

Serverhttps://magaza-adiniz.myideasoft.com

PaymentGateway LIST

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

PaymentGateway LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 250

Bir sayfada gelecek PaymentGateways adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. Örnek ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

paymentProvider
​integer · min: -1

Payment Provider Id

paymentProviderCode
​string

Payment Provider Code

q
​string

PaymentGateway arama filtresi. Kullanımı q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme

PaymentGateway LIST › Responses

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

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway POST

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

PaymentGateway POST › Request Body

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway POST › Responses

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

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway COUNT

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

PaymentGateway COUNT › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 250

Bir sayfada gelecek PaymentGateways adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. Örnek ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

paymentProvider
​integer · min: -1

Payment Provider Id

paymentProviderCode
​string

Payment Provider Code

q
​string

PaymentGateway arama filtresi. Kullanımı q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme

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


PaymentGateway GET

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

PaymentGateway GET › path Parameters

id
​string · pattern: \d+ · required

PaymentGateway GET › Responses

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

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway PUT

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

PaymentGateway PUT › path Parameters

id
​string · pattern: \d+ · required

PaymentGateway PUT › Request Body

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway PUT › Responses

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

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

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

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

PaymentGateway DELETE

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

PaymentGateway DELETE › path Parameters

id
​string · pattern: \d+ · required

PaymentGateway DELETE › Responses

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

No data returned