Skip to main content
GET
/
api
/
v1
/
payment-links
List payment links with context-aware access control
curl --request GET \
  --url https://core.quidkey.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://core.quidkey.com/api/v1/payment-links")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 25,
    "totalPages": 6,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}
{
"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.

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: x >= 1
Examples:

1

2

3

limit
integer
default:25

Number of items per page (max 100)

Required range: 1 <= x <= 100
Examples:

10

25

50

sort
string

Sort field and direction (e.g., "created_at:desc", "amount:asc")

Examples:

"created_at:desc"

"amount:asc"

"updated_at:desc"

status
enum<string>

Payment link status

Available options:
active,
used,
expired,
cancelled
merchant_id
string<uuid>

Filter by merchant ID (admin/partner only)

Search by payment reference or order ID

Response

Success

Paginated response with metadata

success
boolean
required

Indicates if the request was successful

Example:

true

data
object[]
required
pagination
Pagination Metadata · object
required

Metadata for paginated responses