Skip to main content
POST
/
api
/
v1
/
payment-links
Create a new payment link (Partner or Merchant authentication)
curl --request POST \
  --url https://core.quidkey.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order": {
    "amount": 1000,
    "currency": "GBP",
    "payment_reference": "Invoice #123",
    "order_id": "ORD-123456",
    "locale": "en",
    "test_transaction": true
  },
  "redirect_urls": {
    "success_url": "https://example.com/payment/success",
    "failure_url": "https://example.com/payment/failure"
  }
}
'
import requests

url = "https://core.quidkey.com/api/v1/payment-links"

payload = {
"order": {
"amount": 1000,
"currency": "GBP",
"payment_reference": "Invoice #123",
"order_id": "ORD-123456",
"locale": "en",
"test_transaction": True
},
"redirect_urls": {
"success_url": "https://example.com/payment/success",
"failure_url": "https://example.com/payment/failure"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order: {
amount: 1000,
currency: 'GBP',
payment_reference: 'Invoice #123',
order_id: 'ORD-123456',
locale: 'en',
test_transaction: true
},
redirect_urls: {
success_url: 'https://example.com/payment/success',
failure_url: 'https://example.com/payment/failure'
}
})
};

fetch('https://core.quidkey.com/api/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://core.quidkey.com/api/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 => json_encode([
'order' => [
'amount' => 1000,
'currency' => 'GBP',
'payment_reference' => 'Invoice #123',
'order_id' => 'ORD-123456',
'locale' => 'en',
'test_transaction' => true
],
'redirect_urls' => [
'success_url' => 'https://example.com/payment/success',
'failure_url' => 'https://example.com/payment/failure'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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://core.quidkey.com/api/v1/payment-links"

payload := strings.NewReader("{\n \"order\": {\n \"amount\": 1000,\n \"currency\": \"GBP\",\n \"payment_reference\": \"Invoice #123\",\n \"order_id\": \"ORD-123456\",\n \"locale\": \"en\",\n \"test_transaction\": true\n },\n \"redirect_urls\": {\n \"success_url\": \"https://example.com/payment/success\",\n \"failure_url\": \"https://example.com/payment/failure\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://core.quidkey.com/api/v1/payment-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"order\": {\n \"amount\": 1000,\n \"currency\": \"GBP\",\n \"payment_reference\": \"Invoice #123\",\n \"order_id\": \"ORD-123456\",\n \"locale\": \"en\",\n \"test_transaction\": true\n },\n \"redirect_urls\": {\n \"success_url\": \"https://example.com/payment/success\",\n \"failure_url\": \"https://example.com/payment/failure\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://core.quidkey.com/api/v1/payment-links")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"order\": {\n \"amount\": 1000,\n \"currency\": \"GBP\",\n \"payment_reference\": \"Invoice #123\",\n \"order_id\": \"ORD-123456\",\n \"locale\": \"en\",\n \"test_transaction\": true\n },\n \"redirect_urls\": {\n \"success_url\": \"https://example.com/payment/success\",\n \"failure_url\": \"https://example.com/payment/failure\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "payment_link_url": "https://core.quidkey.com/payment-link/a1b2c3d4e5f6..."
  }
}
{
"success": false,
"error": {
"message": "Invalid input provided"
}
}
{
"success": false,
"error": {
"message": "Invalid input provided"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body

order
object
required
merchant_id
string<uuid>

Required for Partner authentication, forbidden for Merchant authentication

metadata
object

Optional metadata to attach to the payment link

redirect_urls
object

Response

Created

success
boolean
required

Indicates if the request was successful

Example:

true

data
object
required