Fetch Payment Links
curl --request GET \
--url 'https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10' \
--header 'Authorization: <api-key>'import requests
url = "https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10', 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.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10",
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: <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"
"net/http"
"io"
)
func main() {
url := "https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Payment Links fetched successfully",
"data": {
"items": [
{
"id": 10011,
"link": "https://business.payaza.africa/pay/devconference",
"has_fixed_amount": true,
"created_date": "2026-01-10T08:30:00.000000",
"start_date": "2026-01-10T08:30:00.000000",
"business_name": "Tech Solutions Ltd",
"payment_amount": 5000,
"payment_link_name": "DevConference",
"fee_bearer": "Pay by Customer",
"requested_information": [
{
"id": 991,
"attribute_index": 3,
"attribute_name": "CUSTOMER_EMAIL",
"reference_type": "Email Address"
}
],
"total_collected_amount": 15000,
"number_of_usage": 3,
"collect_customer_email": true,
"is_single_use": false
},
{
"id": 10012,
"link": "https://business.payaza.africa/pay/charityfund",
"has_fixed_amount": false,
"created_date": "2026-02-15T14:22:10.123456",
"start_date": "2026-02-15T14:25:00.000000",
"business_name": "Global Charity Org",
"payment_description": "Support our annual charity drive",
"payment_link_name": "CharityFund",
"fee_bearer": "Pay by Business",
"redirect_url": "https://example.com/thank-you",
"requested_information": [
{
"id": 992,
"attribute_index": 1,
"attribute_name": "CUSTOMER_FIRST_NAME",
"reference_type": "First Name"
},
{
"id": 993,
"attribute_index": 2,
"attribute_name": "CUSTOMER_LAST_NAME",
"reference_type": "Last Name"
},
{
"id": 994,
"attribute_index": 3,
"attribute_name": "CUSTOMER_EMAIL",
"reference_type": "Email Address"
}
],
"total_collected_amount": 8500.5,
"number_of_usage": 12,
"collect_customer_first_and_last_name": true,
"collect_customer_email": true,
"is_single_use": false
},
{
"id": 10013,
"link": "https://business.payaza.africa/pay/premiumconsult",
"has_fixed_amount": true,
"created_date": "2026-03-01T09:15:00.000000",
"start_date": "2026-03-05T09:00:00.000000",
"business_name": "Consulting Experts Group",
"payment_amount": 150000,
"payment_description": "1-hour premium consultation session",
"payment_link_name": "PremiumConsult",
"fee_bearer": "Pay by Customer",
"requested_information": [],
"total_collected_amount": 0,
"number_of_usage": 0,
"collect_customer_email": false,
"is_single_use": true
}
],
"pagination": {
"total": 3,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}Payment Links
Fetch Payment Links
It retrieves the list of payment links that have been created.
GET
/
payment-link
/
merchant
/
fetch-payment-links?search=&page=3&size=10
Fetch Payment Links
curl --request GET \
--url 'https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10' \
--header 'Authorization: <api-key>'import requests
url = "https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10', 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.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10",
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: <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"
"net/http"
"io"
)
func main() {
url := "https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payaza.africa/live/payment-link/merchant/fetch-payment-links?search=&page=3&size=10")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Payment Links fetched successfully",
"data": {
"items": [
{
"id": 10011,
"link": "https://business.payaza.africa/pay/devconference",
"has_fixed_amount": true,
"created_date": "2026-01-10T08:30:00.000000",
"start_date": "2026-01-10T08:30:00.000000",
"business_name": "Tech Solutions Ltd",
"payment_amount": 5000,
"payment_link_name": "DevConference",
"fee_bearer": "Pay by Customer",
"requested_information": [
{
"id": 991,
"attribute_index": 3,
"attribute_name": "CUSTOMER_EMAIL",
"reference_type": "Email Address"
}
],
"total_collected_amount": 15000,
"number_of_usage": 3,
"collect_customer_email": true,
"is_single_use": false
},
{
"id": 10012,
"link": "https://business.payaza.africa/pay/charityfund",
"has_fixed_amount": false,
"created_date": "2026-02-15T14:22:10.123456",
"start_date": "2026-02-15T14:25:00.000000",
"business_name": "Global Charity Org",
"payment_description": "Support our annual charity drive",
"payment_link_name": "CharityFund",
"fee_bearer": "Pay by Business",
"redirect_url": "https://example.com/thank-you",
"requested_information": [
{
"id": 992,
"attribute_index": 1,
"attribute_name": "CUSTOMER_FIRST_NAME",
"reference_type": "First Name"
},
{
"id": 993,
"attribute_index": 2,
"attribute_name": "CUSTOMER_LAST_NAME",
"reference_type": "Last Name"
},
{
"id": 994,
"attribute_index": 3,
"attribute_name": "CUSTOMER_EMAIL",
"reference_type": "Email Address"
}
],
"total_collected_amount": 8500.5,
"number_of_usage": 12,
"collect_customer_first_and_last_name": true,
"collect_customer_email": true,
"is_single_use": false
},
{
"id": 10013,
"link": "https://business.payaza.africa/pay/premiumconsult",
"has_fixed_amount": true,
"created_date": "2026-03-01T09:15:00.000000",
"start_date": "2026-03-05T09:00:00.000000",
"business_name": "Consulting Experts Group",
"payment_amount": 150000,
"payment_description": "1-hour premium consultation session",
"payment_link_name": "PremiumConsult",
"fee_bearer": "Pay by Customer",
"requested_information": [],
"total_collected_amount": 0,
"number_of_usage": 0,
"collect_customer_email": false,
"is_single_use": true
}
],
"pagination": {
"total": 3,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}Authorizations
Payaza {{Public API Key in Base 64}}
Query Parameters
The search term to filter payment links.
The page number to be retrieved.
The number of records per page.
Response
Request Successful