Update
curl --request PATCH \
--url https://api.blockradar.co/v1/payment_links/{id} \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form active=true \
--form 'name=Updated Name' \
--form redirectUrl=https://www.blockradar.co/ \
--form slug=new-01 \
--form successMessage=Heyimport requests
url = "https://api.blockradar.co/v1/payment_links/{id}"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.patch(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('active', 'true');
form.append('name', 'Updated Name');
form.append('redirectUrl', 'https://www.blockradar.co/');
form.append('slug', 'new-01');
form.append('successMessage', 'Hey');
const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.blockradar.co/v1/payment_links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blockradar.co/v1/payment_links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blockradar.co/v1/payment_links/{id}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.blockradar.co/v1/payment_links/{id}")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blockradar.co/v1/payment_links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"active": true,
"amount": "100",
"configurations": {},
"createdAt": "2024-11-09T12:07:07.574Z",
"created_channel": "dashboard",
"currency": "USD",
"description": "Payment link description",
"id": "929685ad-3087-4ef2-9961-34817ee107ca",
"imageUrl": null,
"inactiveMessage": null,
"metadata": {},
"name": "Payment Link",
"network": "mainnet",
"redirectUrl": "https://www.blockradar.co/",
"slug": "iZ8d39yLN2",
"successMessage": null,
"type": "payment",
"updatedAt": "2024-11-09T12:08:24.226Z"
},
"message": "Payment Link updated successfully",
"statusCode": 200
}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}
Update
curl --request PATCH \
--url https://api.blockradar.co/v1/payment_links/{id} \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form active=true \
--form 'name=Updated Name' \
--form redirectUrl=https://www.blockradar.co/ \
--form slug=new-01 \
--form successMessage=Heyimport requests
url = "https://api.blockradar.co/v1/payment_links/{id}"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.patch(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('active', 'true');
form.append('name', 'Updated Name');
form.append('redirectUrl', 'https://www.blockradar.co/');
form.append('slug', 'new-01');
form.append('successMessage', 'Hey');
const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.blockradar.co/v1/payment_links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blockradar.co/v1/payment_links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blockradar.co/v1/payment_links/{id}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.blockradar.co/v1/payment_links/{id}")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blockradar.co/v1/payment_links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nUpdated Name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\nhttps://www.blockradar.co/\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\nnew-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\nHey\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"active": true,
"amount": "100",
"configurations": {},
"createdAt": "2024-11-09T12:07:07.574Z",
"created_channel": "dashboard",
"currency": "USD",
"description": "Payment link description",
"id": "929685ad-3087-4ef2-9961-34817ee107ca",
"imageUrl": null,
"inactiveMessage": null,
"metadata": {},
"name": "Payment Link",
"network": "mainnet",
"redirectUrl": "https://www.blockradar.co/",
"slug": "iZ8d39yLN2",
"successMessage": null,
"type": "payment",
"updatedAt": "2024-11-09T12:08:24.226Z"
},
"message": "Payment Link updated successfully",
"statusCode": 200
}Authorizations
Path Parameters
Example:
"Payment_link_id"
Body
multipart/form-data
⌘I

