Skip to content

MngGetCashierPaymentModules

Returns the Cashier payment module catalog discovered during CashierManager initialization.

During startup Cashier scans the payments directory, preloads each payment module, checks the SDK API version, calls GetPaymentProviderDescriptor(out), stores descriptor data in memory, and unloads the preload handle. Enabled provider configs are initialized later from this validated catalog.

Access

SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Request Parameters

No request parameters.

Response Fields

Name Type Description
rows array Discovered payment modules
count int Number of returned modules

Payment Module

Name Type Description
code string Provider code returned by GetPaymentProviderDescriptor
name string Provider display name
description string Provider description
payment_mode string Payment mode, for example redirect
module_name string .so module file name
path string Module path discovered in the payments directory
api_version int Payment SDK API version returned by the module
available int 1 when module passed preload checks, 0 otherwise
failure_reason string Failure reason for unavailable modules

Request Example

{
  "command": "MngGetCashierPaymentModules",
  "extID": "1",
  "data": {}
}

Response Example

{
  "rows": [
    {
      "code": "praxis",
      "name": "Praxis Cashier",
      "description": "Praxis-style hosted cashier redirect provider",
      "payment_mode": "redirect",
      "module_name": "libPraxisPayment.so",
      "path": "payments/libPraxisPayment.so",
      "api_version": 100,
      "available": 1,
      "failure_reason": ""
    }
  ],
  "count": 1
}