v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Payment Links

Update

This endpoint allows you to update the details of a specific payment link.

Body Parameters

Key	Required	Type	Description
name	false	string (max: 250)	The name of the payment link.
description	false	string (max: 250)	A description of the payment link.
slug	false	string (max: 250)	A unique identifier (URL-friendly). Must match regex: ^[a-zA-Z0-9-]+$.
amount	false	string	The amount for the payment link. Must be a valid string number > 0.
redirectUrl	false	string (URL)	The URL to redirect the user after payment. Must include http:// or https://.
successMessage	false	string (max: 500)	Message shown when the payment succeeds.
active	false	boolean	Indicates whether the payment link is active.
inactiveMessage	false	string (max: 500)	Message shown when the payment link is inactive.
metadata	false	object (JSON string)	Custom metadata as key-value pairs (string or number). Must be sent as a JSON string in form-data.
paymentLimit	false	number (min: 1)	Maximum number of payments allowed for this link.
file	false	file	An optional file upload (e.g., image or document) attached to the payment link.

patch/v1/payment_links/{id}

Response

200

messagestring

statusCodenumber

Example response

{
  "data": {
    "active": true,
    "amount": "100",
    "createdAt": "2024-11-09T12:07:07.574Z",
    "created_channel": "dashboard",
    "currency": "USD",
    "description": "Payment link description",
    "id": "929685ad-3087-4ef2-9961-34817ee107ca",
    "name": "Payment Link",
    "network": "mainnet",
    "redirectUrl": "https://www.blockradar.co/",
    "slug": "iZ8d39yLN2",
    "type": "payment",
    "updatedAt": "2024-11-09T12:08:24.226Z"
  },
  "message": "Payment Link updated successfully",
  "statusCode": 200
}