Skip to content

MngGetCashierProviders

Returns configured Cashier providers and currently loaded payment provider modules.

The method returns two lists:

  • rows: persisted provider configuration records from cashier_provider_configs;
  • runtime_providers: payment provider modules loaded from the payments directory during CashierManager initialization.

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 Config 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
runtime_providers array Loaded payment provider modules

Provider Config

Name Type Description
id int Config id
provider string Provider code
brand string Brand code or empty for generic config
method string Payment method marker
country string Country filter
currency string Currency filter
merchant_id string Merchant/account id
public_key string Public provider key
secret_key string Hidden in response
webhook_secret string Hidden in response
settings_json string Provider settings JSON string
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

Runtime Provider

Name Type Description
code string Provider code returned by module
name string Provider display name
description string Provider description
payment_mode string Payment mode, for example redirect
module_name string Loaded .so module name
path string Module path
api_version int Payment API version
enabled int Runtime load status

Request Example

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

Response Example

{
  "rows": [
    {
      "id": 1,
      "provider": "stripe",
      "brand": "default",
      "method": "card",
      "country": "",
      "currency": "USD",
      "merchant_id": "acct_123",
      "public_key": "pk_live_xxx",
      "secret_key": "",
      "webhook_secret": "",
      "settings_json": "{}",
      "min_amount": 10.0,
      "max_amount": 5000.0,
      "sandbox": 0,
      "enabled": 1,
      "sort_index": 100,
      "created_time": 1779270000,
      "updated_time": 1779270000
    }
  ],
  "count": 1,
  "runtime_providers": [
    {
      "code": "stripe",
      "name": "Stripe",
      "description": "Stripe card payments",
      "payment_mode": "redirect",
      "module_name": "libStripePayment",
      "path": "payments/libStripePayment.so",
      "api_version": 100,
      "enabled": 1
    }
  ]
}