PayPlug¶

PayPlug is a payment platform for small and medium-sized businesses to accept online payments.

The PayPlug application allows you to retrieve the status of PayPlug services and check their availability. Status information can be visualized from the PayPlug Status website.

Options

Name*: Just a simple label to find it easier in the SenHub's interface
Description: Description for your own usage only.
Vault*: Choose in the list box the appropriate vault for this resource. If you have not created it yet, see how to add a vault.
Group: optional — assign this instance to a group to organise it within SenHub.
Resource Types*: The type of PayPlug resource you want to retrieve. The options are:
- Service Health — Scrapes the PayPlug Status website and returns one channel per PayPlug service with its current status.
- Payment Information — Returns this month's payment totals and transaction counts (paid, refunded, failed) from your PayPlug account. Requires a Secret Key taken from the selected vault.

Example output

Depending on the selected Resource Type, the connector returns either the current status of each PayPlug service (Service Health) or this month's payment totals and counts (Payment Information).

Service Health — one channel per PayPlug service, valued with its current status:

{
  "metrics": [
    { "channel": "Payment API", "value": "Operational" },
    { "channel": "Checkout Page", "value": "Operational" },
    { "channel": "Merchant Portal", "value": "Operational" }
  ],
  "message": "Metrics successfully retrieved.",
  "status": "OK",
  "date": 1725981405127
}

Payment Information — totals and transaction counts for the current month:

{
  "metrics": [
    { "channel": "Total paid", "value": 1250.00, "unit": "Euros" },
    { "channel": "Total refunded", "value": 90.50, "unit": "Euros" },
    { "channel": "Payments received", "value": 42, "unit": "#" },
    { "channel": "Payments refund", "value": 3, "unit": "#" },
    { "channel": "Payments failed", "value": 5, "unit": "#" }
  ],
  "message": "Metrics successfully retrieved.",
  "status": "OK",
  "date": 1725981405127
}