Get Modules

/api/payhub/v1/modules

Returns the module code, name and description for every licensable Payhub module, so an authenticated System can choose module codes when creating a subscription. Requires a valid System API key (x-system-key header).

Request parameters

Responses

{
  "modules": [
    {
      "code": "MOD-PAYGATE",
      "name": "Paygate Module",
      "description": "Enables Paygate payment processing."
    },
    {
      "code": "MOD-DIAS",
      "name": "Dias Module",
      "description": "Enables DIAS bank transfer payments."
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "/api/payhub/v1/modules",
  "traceId": null,
  "detail": "System API key is missing or invalid",
  "errors": [
    {
      "name": "Authorization",
      "reason": "x-system-key header is required",
      "code": null,
      "severity": null
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more errors occurred.",
  "status": 500,
  "instance": "/api/payhub/v1/modules",
  "traceId": null,
  "detail": "Failed to retrieve modules",
  "errors": [
    {
      "name": "Server",
      "reason": "Internal server error",
      "code": null,
      "severity": null
    }
  ]
}

Last modified: 06 October 2026