Update and delete a Paylink

This page explains how to change and how to remove an existing Paylink. Deleting is a single API call; changing a Paylink's parameters is done by replacing it, because the Merchant API does not offer an in-place update for this resource.

Update a Paylink#

API versions v1.14 to v1.16 do not provide a PUT operation for the Paylink (Invoice) resource, so a Paylink cannot be modified through the API once created. To change the amount, the texts or the expiry date of a link that has not been paid yet:

1. Create a new Paylink with the corrected parameters — see Create a Paylink.
2. Publish the new link wherever the old one was shared (e-mail, QR code, invoice document).
3. Delete the outdated Paylink with the call below so nobody can pay against it anymore.

Delete a Paylink#

Deleting removes the Paylink by its ID; its URL stops accepting payments. Authenticate with the X-API-KEY header — see Authentication.

Path parameters#

Query parameters#

Example request#

curl --request DELETE \
  --url "https://api.pay.flowalp.com/v1.16/Invoice/57/?instance=${FLOWALP_PAY_INSTANCE}" \
  --header "X-API-KEY: ${FLOWALP_PAY_API_SECRET}"

<?php
use FlowAlpPay\FlowAlpPay;
use FlowAlpPay\Models\Request\Paylink;

$client = new FlowAlpPay(
    getenv('FLOWALP_PAY_INSTANCE'),
    getenv('FLOWALP_PAY_API_SECRET'),
    FlowAlpPay::DEFAULT_COMMUNICATION_HANDLER,
    'pay.flowalp.com',
    '1.16'
);

$paylink = new Paylink();
$paylink->setId(57);

$client->delete($paylink);

Response#

A successful call returns HTTP 200 with the success envelope confirming the deleted Paylink.

{
  "status": "success",
  "data": [
    {
      "id": 57
    }
  ]
}

Errors#

Error responses use the envelope {"status": "error", "message": "..."} — see Errors and Rate limits.