API Reference

Cancel Payment Link

POSThttps://api.fiatpe.com/v1/payment-links/{payment_link_id}/cancel//v1/payment-links/{payment_link_id}/cancel/

Cancels an existing payment link using its unique payment link ID. Once cancelled, the link becomes inactive and can no longer be used to accept payments.

Headers

Content-Type

Authorization

UsernamePassword

Sent as Authorization: Basic base64(Api Key:Salt Key)

Path Parameters

payment_link_id*string

REQUEST

curl --request POST \
  --url https://api.fiatpe.com/v1/payment-links/{payment_link_id}/cancel/ \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic YOUR_TOKEN' \
  --data '{}'

RESPONSE

{
  "data": {
    "id": "plink_1e3d427e8c774377",
    "amount": 4500,
    "entity": "payment_link",
    "status": "cancelled",
    "currency": "INR",
    "customer": null,
    "metadata": {},
    "short_url": "https://t.ftpe.pe/link/dduvo0/",
    "created_at": 1785221802,
    "expires_at": 1800773802,
    "updated_at": 1785229790,
    "amount_paid": 0,
    "description": null,
    "cancelled_at": 1785229790,
    "notification": {
      "sms": false,
      "email": false,
      "whatsapp": false
    },
    "reference_id": null,
    "allow_partial": false,
    "allow_upi_link": false,
    "enable_reminders": false,
    "min_partial_amount": 4500,
    "allow_whatsapp_link": false
  },
  "message": "Payment Link cancelled successfully."
}