Skip to content

MngGetCashierProviderConfigsByFilter

Returns Cashier provider configs from the manager's in-memory configuration snapshot.

Provider configs are the payment settings created in CRM. A module-backed config selects a provider from MngGetCashierPaymentModules; a manual config uses execution_mode = 1 and does not require a loaded payment module. Only enabled module-backed configs create dedicated provider instances during Cashier initialization or config update.

In CRM Cashier settings, the Direction column shows the config's purpose: Deposit (0), Withdrawal (1), or Deposit and withdrawal (2, both). The same selection is available when adding or editing a provider config. The column uses transaction_type; it is distinct from execution_mode, which controls whether processing uses a payment module or a manual flow.

Access

SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Requires access_crm scope and see_finance permission. Rows are limited by provider config brand scope.

Filtering and sorting are followed by access checks, then pagination. count is the total number of matching configurations visible to the caller before offset and limit. Inaccessible configurations neither contribute to count nor consume page slots. An offset at or beyond the visible total returns empty rows without changing count. Separate requests may observe configuration changes.

Request Parameters

Name Type Required Description
limit int No Page size, 1..50000; default 100
offset int No Nonnegative offset within visible matching records; default 0
where array No AND filters for provider configs
orWhere array No OR comparison group in [[field, operator, value], ...] format; at least one condition must match
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 First [field, direction] entry is used; fields: id, enabled, sort_index; direction desc or ascending otherwise. Default: sort_index ascending, then id descending

Supported Filter Fields

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

Response Fields

Name Type Description
rows array Requested page of visible matching provider config records
count int Total number of visible matching configs before pagination, not the page length

Provider Config

Name Type Description
id int Config id
provider string Configured provider route code; manual configs may use manual
brand string Brand code or empty for generic config
method string Payment method marker
country string Normalized comma-separated country allowlist; empty means all countries. Codes are uppercase, trimmed, deduplicated two-letter ASCII entries
currency string Currency filter
transaction_type int 0 deposit, 1 withdrawal, 2 both
execution_mode int 0 payment module, 1 manual
payment_mode string Payment mode marker
display_name string Display name
description string Display description
form_schema_json string Original form schema JSON string
form_schema object Parsed form schema; empty object if the string is not a valid JSON object
settings_json string Provider settings JSON string; manual deposit configs use it for public receiving instructions
config_json string Always an empty string in this response because the configuration 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": 1,
    "offset": 0,
    "where": [
      ["enabled", "=", 1]
    ]
  }
}

Manual deposit configs use settings_json for the public receiving instructions. The customer REST GetCashierMethods response returns the eligible method and its form_schema; after submission, CreateCashierDeposit returns those receiving instructions in payment.instructions_json.

Response Example

Complete TCP response for the request above when 25 visible configs match. The payload is in data; extID echoes the request correlation identifier and status is the response status code.

{
  "extID": "1",
  "status": 200,
  "data": {
  "rows": [
    {
      "id": 1,
      "provider": "praxis",
      "brand": "default",
      "method": "card",
      "country": "",
      "currency": "USD",
      "transaction_type": 0,
      "execution_mode": 0,
      "payment_mode": "",
      "display_name": "Card payment",
      "description": "",
      "form_schema_json": "{}",
      "form_schema": {},
      "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": 25
  }
}