Aggiornare ed eliminare un Paylink

Questa pagina spiega come modificare e come rimuovere un Paylink esistente. L'eliminazione è una singola chiamata API; la modifica dei parametri avviene invece per sostituzione, perché la Merchant API non offre un aggiornamento in place per questa risorsa.

Aggiornare un Paylink#

Le versioni API da v1.14 a v1.16 non prevedono un'operazione PUT per la risorsa Paylink (Invoice): una volta creato, un Paylink non può essere modificato via API. Per cambiare importo, testi o data di scadenza di un link non ancora pagato:

1. Crea un nuovo Paylink con i parametri corretti — vedi Creare un Paylink.
2. Pubblica il nuovo link ovunque fosse condiviso quello vecchio (e-mail, codice QR, documento di fattura).
3. Elimina il Paylink obsoleto con la chiamata qui sotto, così nessuno potrà più pagarci sopra.

Eliminare un Paylink#

L'eliminazione rimuove il Paylink a partire dal suo ID; il suo URL smette di accettare pagamenti. Autenticati con l'header X-API-KEY — vedi Autenticazione.

Path parameter#

Query parameter#

Esempio di 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#

Una chiamata riuscita restituisce HTTP 200 con l'envelope di successo che conferma il Paylink eliminato.

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

Errori#

Le response di errore usano l'envelope {"status": "error", "message": "..."} — vedi Errori e Rate limit.