List payment links
curl --request GET \
--url https://sandbox-api.kotanipay.io/api/v3/payment-links \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/payment-links")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/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,
"message": "Payment links retrieved successfully",
"data": [
{
"id": "<string>",
"shortCode": "<string>",
"url": "https://pay.kotanipay.com/abc123",
"name": "<string>",
"type": "standard",
"pricing": {
"type": "fixed",
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [
"mobile_money"
],
"usageType": "single_use",
"currentUses": 123,
"isActive": true,
"collectCustomerInfo": {
"email": "required",
"phone": "required",
"name": "required",
"address": "required"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"paymentMethodConfig": {
"mobileMoneyProviders": [
"<string>"
],
"mobileMoneyCurrencies": [
"KES",
"GHS"
],
"mobileMoneyCountries": [
"<string>"
],
"supportedCurrencies": [
"<string>"
],
"cryptoNetworks": [
"<string>"
],
"cryptoCurrencies": [
"USDT",
"USDC"
],
"cardCurrencies": [
"<string>"
],
"cardCountries": [
"<string>"
],
"bankCurrencies": [
"<string>"
],
"bankCountries": [
"<string>"
]
},
"maxUses": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"afterPayment": {
"type": "message",
"message": "<string>",
"redirectUrl": "https://yourdomain.com/thank-you"
},
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"qrCodeUrl": "<string>",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Payment Links
List Payment Links
GET
/
api
/
v3
/
payment-links
List payment links
curl --request GET \
--url https://sandbox-api.kotanipay.io/api/v3/payment-links \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/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://sandbox-api.kotanipay.io/api/v3/payment-links")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/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,
"message": "Payment links retrieved successfully",
"data": [
{
"id": "<string>",
"shortCode": "<string>",
"url": "https://pay.kotanipay.com/abc123",
"name": "<string>",
"type": "standard",
"pricing": {
"type": "fixed",
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [
"mobile_money"
],
"usageType": "single_use",
"currentUses": 123,
"isActive": true,
"collectCustomerInfo": {
"email": "required",
"phone": "required",
"name": "required",
"address": "required"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"paymentMethodConfig": {
"mobileMoneyProviders": [
"<string>"
],
"mobileMoneyCurrencies": [
"KES",
"GHS"
],
"mobileMoneyCountries": [
"<string>"
],
"supportedCurrencies": [
"<string>"
],
"cryptoNetworks": [
"<string>"
],
"cryptoCurrencies": [
"USDT",
"USDC"
],
"cardCurrencies": [
"<string>"
],
"cardCountries": [
"<string>"
],
"bankCurrencies": [
"<string>"
],
"bankCountries": [
"<string>"
]
},
"maxUses": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"afterPayment": {
"type": "message",
"message": "<string>",
"redirectUrl": "https://yourdomain.com/thank-you"
},
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"qrCodeUrl": "<string>",
"lastUsedAt": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}List your payment links with pagination, filterable by type, active status, and a free-text search across name/description.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Available options:
standard, invoice, donation