Contents
On this page
Cancel Payment Link - Plugixa POS for WooCommerce
POST /plugixa-pos/v1/pay-links/payments/{link}/cancel
Stop a link that was not paid.
Needs a user with the plugixa_pos_sell 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. The user must also be allowed to use the register (register access).
Request
POST https://your-site.example/wp-json/plugixa-pos/v1/pay-links/payments/pl4f8a2c9e1b7d3f6a05/cancel
Path parameters
| Name | Type | Description |
|---|---|---|
link |
string |
The payment’s id, pl and 18 hex characters |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
register_id |
integer |
Yes | The register. |
{
"register_id": 1
}
Responses
200 OK.
{
"success": true,
"data": {
"status": "canceled",
"message": "The payment was canceled."
}
}
| Field | Type | Meaning |
|---|---|---|
data.status |
string |
pending, succeeded, failed or canceled |
data.message |
string |
Why it failed or was canceled, ready to show |
Errors
| Status | Code | When |
|---|---|---|
403 |
plugixa_pos_forbidden |
The user may not use this register (this route answers with this code rather than plugixa_pos_register_forbidden). |
404 |
plugixa_pos_not_found |
Not started at this register. |
Plus the errors every endpoint can return.
Examples
curl -s -X POST "https://your-site.example/wp-json/plugixa-pos/v1/pay-links/payments/pl4f8a2c9e1b7d3f6a05/cancel" \
-u "$WP_USER:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"register_id":1}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/pay-links/payments/pl4f8a2c9e1b7d3f6a05/cancel');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode([
'register_id' => 1,
]),
]);
$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/payments/pl4f8a2c9e1b7d3f6a05/cancel', {
method: 'POST',
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ register_id: 1 }),
});
const { data } = await response.json();
Quick Links
Share