Skip to content

MngGetCashierProviderConfigsByFilter

Returns persisted Cashier provider configs from cashier_provider_configs.

Provider configs are the activated payment settings created by CRM after a manager selects a module from MngGetCashierPaymentModules. Each enabled config creates a dedicated provider instance during Cashier initialization or config update.

Access

SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Request Parameters

Name Type Required Description
limit int No Page size, 1..50000
offset int No Pagination offset
where array No AND filters for provider configs
whereNot array No Negative filters
whereIn array No Include-by-list filters
whereNotIn array No Exclude-by-list filters
whereBetween array No Range filters
whereNotBetween array No Negative range filters
orderBy array No Sort expression

Supported Filter Fields

Field Type
id int
enabled int
sandbox int
provider string
brand string
method string
currency string
country string

Response Fields

Name Type Description
rows array Provider config records
count int Total number of matching config rows

Provider Config

Name Type Description
id int Config id
provider string Provider code from the payment module descriptor
brand string Brand code or empty for generic config
method string Payment method marker
country string Country filter
currency string Currency filter
settings_json string Customer-visible provider settings JSON string
config_json string Provider-specific config JSON. Hidden in response because it may contain credentials
min_amount double Minimum amount
max_amount double Maximum amount
sandbox int 1 sandbox mode, 0 production mode
enabled int 1 enabled, 0 disabled
sort_index int Sorting priority
created_time int64 Creation timestamp
updated_time int64 Last update timestamp

Request Example

{
  "command": "MngGetCashierProviderConfigsByFilter",
  "extID": "1",
  "data": {
    "limit": 100,
    "offset": 0,
    "where": [
      ["enabled", "=", 1]
    ]
  }
}

Response Example

{
  "rows": [
    {
      "id": 1,
      "provider": "praxis",
      "brand": "default",
      "method": "card",
      "country": "",
      "currency": "USD",
      "settings_json": "{}",
      "config_json": "",
      "min_amount": 10.0,
      "max_amount": 5000.0,
      "sandbox": 0,
      "enabled": 1,
      "sort_index": 100,
      "created_time": 1779270000,
      "updated_time": 1779270000
    }
  ],
  "count": 1
}