Create a payment link
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pricing": {
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [],
"collectCustomerInfo": {},
"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",
"callbackUrl": "https://yourdomain.com/webhook",
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"metadata": {}
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/payment-links"
payload = {
"name": "<string>",
"pricing": {
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [],
"collectCustomerInfo": {},
"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",
"callbackUrl": "https://yourdomain.com/webhook",
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"metadata": {}
}
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({
name: '<string>',
pricing: {
currency: 'KES',
referenceCurrency: 'KES',
amount: 123,
minAmount: 123,
maxAmount: 123,
packages: [
{
id: '<string>',
name: '<string>',
amount: 123,
currency: 'KES',
description: '<string>'
}
]
},
enabledPaymentMethods: [],
collectCustomerInfo: {},
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',
callbackUrl: 'https://yourdomain.com/webhook',
branding: {
logoUrl: 'https://yourdomain.com/logo.png',
primaryColor: '#0084FF',
backgroundColor: '#FFFFFF'
},
metadata: {}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'pricing' => [
'currency' => 'KES',
'referenceCurrency' => 'KES',
'amount' => 123,
'minAmount' => 123,
'maxAmount' => 123,
'packages' => [
[
'id' => '<string>',
'name' => '<string>',
'amount' => 123,
'currency' => 'KES',
'description' => '<string>'
]
]
],
'enabledPaymentMethods' => [
],
'collectCustomerInfo' => [
],
'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',
'callbackUrl' => 'https://yourdomain.com/webhook',
'branding' => [
'logoUrl' => 'https://yourdomain.com/logo.png',
'primaryColor' => '#0084FF',
'backgroundColor' => '#FFFFFF'
],
'metadata' => [
]
]),
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://sandbox-api.kotanipay.io/api/v3/payment-links"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\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://sandbox-api.kotanipay.io/api/v3/payment-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payment link created 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"
}
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Payment Links
Create Payment Link
Creates a new payment link that can be shared with a customer to collect payment.
POST
/
api
/
v3
/
payment-links
Create a payment link
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pricing": {
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [],
"collectCustomerInfo": {},
"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",
"callbackUrl": "https://yourdomain.com/webhook",
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"metadata": {}
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/payment-links"
payload = {
"name": "<string>",
"pricing": {
"currency": "KES",
"referenceCurrency": "KES",
"amount": 123,
"minAmount": 123,
"maxAmount": 123,
"packages": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "KES",
"description": "<string>"
}
]
},
"enabledPaymentMethods": [],
"collectCustomerInfo": {},
"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",
"callbackUrl": "https://yourdomain.com/webhook",
"branding": {
"logoUrl": "https://yourdomain.com/logo.png",
"primaryColor": "#0084FF",
"backgroundColor": "#FFFFFF"
},
"metadata": {}
}
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({
name: '<string>',
pricing: {
currency: 'KES',
referenceCurrency: 'KES',
amount: 123,
minAmount: 123,
maxAmount: 123,
packages: [
{
id: '<string>',
name: '<string>',
amount: 123,
currency: 'KES',
description: '<string>'
}
]
},
enabledPaymentMethods: [],
collectCustomerInfo: {},
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',
callbackUrl: 'https://yourdomain.com/webhook',
branding: {
logoUrl: 'https://yourdomain.com/logo.png',
primaryColor: '#0084FF',
backgroundColor: '#FFFFFF'
},
metadata: {}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'pricing' => [
'currency' => 'KES',
'referenceCurrency' => 'KES',
'amount' => 123,
'minAmount' => 123,
'maxAmount' => 123,
'packages' => [
[
'id' => '<string>',
'name' => '<string>',
'amount' => 123,
'currency' => 'KES',
'description' => '<string>'
]
]
],
'enabledPaymentMethods' => [
],
'collectCustomerInfo' => [
],
'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',
'callbackUrl' => 'https://yourdomain.com/webhook',
'branding' => [
'logoUrl' => 'https://yourdomain.com/logo.png',
'primaryColor' => '#0084FF',
'backgroundColor' => '#FFFFFF'
],
'metadata' => [
]
]),
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://sandbox-api.kotanipay.io/api/v3/payment-links"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\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://sandbox-api.kotanipay.io/api/v3/payment-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"pricing\": {\n \"currency\": \"KES\",\n \"referenceCurrency\": \"KES\",\n \"amount\": 123,\n \"minAmount\": 123,\n \"maxAmount\": 123,\n \"packages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"KES\",\n \"description\": \"<string>\"\n }\n ]\n },\n \"enabledPaymentMethods\": [],\n \"collectCustomerInfo\": {},\n \"description\": \"<string>\",\n \"paymentMethodConfig\": {\n \"mobileMoneyProviders\": [\n \"<string>\"\n ],\n \"mobileMoneyCurrencies\": [\n \"KES\",\n \"GHS\"\n ],\n \"mobileMoneyCountries\": [\n \"<string>\"\n ],\n \"supportedCurrencies\": [\n \"<string>\"\n ],\n \"cryptoNetworks\": [\n \"<string>\"\n ],\n \"cryptoCurrencies\": [\n \"USDT\",\n \"USDC\"\n ],\n \"cardCurrencies\": [\n \"<string>\"\n ],\n \"cardCountries\": [\n \"<string>\"\n ],\n \"bankCurrencies\": [\n \"<string>\"\n ],\n \"bankCountries\": [\n \"<string>\"\n ]\n },\n \"maxUses\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"callbackUrl\": \"https://yourdomain.com/webhook\",\n \"branding\": {\n \"logoUrl\": \"https://yourdomain.com/logo.png\",\n \"primaryColor\": \"#0084FF\",\n \"backgroundColor\": \"#FFFFFF\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payment link created 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"
}
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Creates a new payment link that can be shared with a customer to collect payment. Returns a hosted checkout URL — no frontend required on your end.
pricing.type drives which of amount, minAmount/maxAmount, or packages you need to set: fixed needs amount, variable needs minAmount/maxAmount (or neither, for customer_choice), package needs packages.usageType: "limited_use" requires maxUses. single_use and multi_use ignore it.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
standard, invoice, donation Show child attributes
Show child attributes
Available options:
mobile_money, bank, card, crypto Available options:
single_use, multi_use, limited_use Whether email, phone, name, and address are required, optional, or not collected at checkout.
Show child attributes
Show child attributes
Restricts which providers/currencies/networks/countries are offered per payment method. All fields optional — omit to allow everything enabled on your account.
Show child attributes
Show child attributes
Used when usageType is limited_use.
Show child attributes
Show child attributes
Example:
"https://yourdomain.com/webhook"
Show child attributes
Show child attributes