Contents
On this page

Get Pay by Link Setup - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/pay-links

Every provider, whether it is on, its fields and the saved values. Secret values come back as their last characters only.

Needs a user with the plugixa_pos_manage_settings capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/pay-links

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": "stripe",
      "label": "Stripe",
      "enabled": true,
      "test": true,
      "fields": [
        {
          "key": "secret_key",
          "label": "Secret key (sk_test_ or sk_live_)",
          "type": "text",
          "secret": true
        }
      ],
      "values": {
        "secret_key": "…UowE"
      },
      "webhook": null
    },
    {
      "id": "mollie",
      "label": "Mollie",
      "enabled": false,
      "test": false,
      "fields": [
        {
          "key": "api_key",
          "label": "API key (test_ or live_)",
          "type": "text",
          "secret": true
        }
      ],
      "values": {
        "api_key": ""
      },
      "webhook": null
    }
  ]
}
Field Type Meaning
data[].id string stripe, paypal, mollie, adyen or klarna
data[].test boolean Test mode
data[].fields object[] The settings it takes: key, label, type (text or bool), secret
data[].values object Saved values
data[].webhook string|null A webhook address to give the provider, when it uses one

Errors

This endpoint has no errors of its own.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/pay-links" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/pay-links');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/pay-links', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share