Create

This endpoint allows you to create a payment link with the specified details.

Body Parameters

Key	Required	Type	Description
name	true	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.
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.

POST /v1/payment_links

Create

cURL

curl --request POST \
  --url https://api.blockradar.co/v1/payment_links \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form amount=100 \
  --form 'description=Test Payment link description' \
  --form file='@example-file' \
  --form inactiveMessage= \
  --form metadata= \
  --form 'name=Payment link name' \
  --form paymentLimit= \
  --form redirectUrl= \
  --form slug=payment-link \
  --form successMessage=

import requests

url = "https://api.blockradar.co/v1/payment_links"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "amount": "100",
    "description": "Test Payment link description",
    "inactiveMessage": "",
    "metadata": "",
    "name": "Payment link name",
    "paymentLimit": "",
    "redirectUrl": "",
    "slug": "payment-link",
    "successMessage": ""
}
headers = {"x-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('amount', '100');
form.append('description', 'Test Payment link description');
form.append('file', '<string>');
form.append('inactiveMessage', '');
form.append('metadata', '');
form.append('name', 'Payment link name');
form.append('paymentLimit', '');
form.append('redirectUrl', '');
form.append('slug', 'payment-link');
form.append('successMessage', '');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.blockradar.co/v1/payment_links', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nTest Payment link description\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inactiveMessage\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nPayment link name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"paymentLimit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\npayment-link\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\n\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"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nTest Payment link description\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inactiveMessage\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nPayment link name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"paymentLimit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\npayment-link\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\n\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", 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.post("https://api.blockradar.co/v1/payment_links")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nTest Payment link description\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inactiveMessage\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nPayment link name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"paymentLimit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\npayment-link\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\n\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/payment_links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nTest Payment link description\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inactiveMessage\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nPayment link name\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"paymentLimit\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"redirectUrl\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\npayment-link\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"successMessage\"\r\n\r\n\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "active": true,
    "amount": null,
    "configurations": {},
    "createdAt": "2025-04-30T14:00:48.522Z",
    "createdChannel": "dashboard",
    "currency": "USD",
    "description": "Payment link description",
    "id": "7dfa86ff-fd3a-45e1-8ecf-dc8a06ef65cd",
    "imageUrl": null,
    "inactiveMessage": null,
    "metadata": null,
    "name": "Payment Link",
    "network": "testnet",
    "redirectUrl": "https://www.blockradar.co/",
    "slug": "payment-link-10012",
    "successMessage": null,
    "type": "payment",
    "updatedAt": "2025-04-30T14:00:48.522Z",
    "url": "https://pay.blockradar.co/payment-link-10012"
  },
  "message": "Payment Link created successfully",
  "statusCode": 200
}

Authorizations

x-api-key · string · header · required

Body

multipart/form-data

amount · string

Example:

"100"

description · string

Example:

"Test Payment link description"

file · file

inactiveMessage · string

Example:

""

metadata · string

Example:

""

name · string

Example:

"Payment link name"

paymentLimit · string

Example:

""

redirectUrl · string

Example:

""

slug · string

Example:

"payment-link"

successMessage · string

Example:

""

Response

200 - application/json

200

data · object

Show child attributes

message · string

Example:

"Payment Link created successfully"

statusCode · number

Example:

200