Request a salary advance
curl --request POST \
--url https://api.kuahr.com/v1/advances \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"termMonths": 3
}
'import requests
url = "https://api.kuahr.com/v1/advances"
payload = {
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"termMonths": 3
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employeeId: 'b2c3d4e5-0000-0000-0000-000000000001',
amountMinor: 5000000,
termMonths: 3
})
};
fetch('https://api.kuahr.com/v1/advances', 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.kuahr.com/v1/advances",
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([
'employeeId' => 'b2c3d4e5-0000-0000-0000-000000000001',
'amountMinor' => 5000000,
'termMonths' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kuahr.com/v1/advances"
payload := strings.NewReader("{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.kuahr.com/v1/advances")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kuahr.com/v1/advances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "9f8e7d6c-0000-0000-0000-000000000001",
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"totalRepayableMinor": 5000000,
"currencyIsoCode": "NGN",
"termMonths": 3,
"status": "Pending",
"disbursedAt": null,
"createdAt": "2026-07-20T11:00:00+00:00"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Advances
Request a salary advance
Requests an advance for an employee (starts Pending). Requires advances:write.
POST
/
v1
/
advances
Request a salary advance
curl --request POST \
--url https://api.kuahr.com/v1/advances \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"termMonths": 3
}
'import requests
url = "https://api.kuahr.com/v1/advances"
payload = {
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"termMonths": 3
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employeeId: 'b2c3d4e5-0000-0000-0000-000000000001',
amountMinor: 5000000,
termMonths: 3
})
};
fetch('https://api.kuahr.com/v1/advances', 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.kuahr.com/v1/advances",
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([
'employeeId' => 'b2c3d4e5-0000-0000-0000-000000000001',
'amountMinor' => 5000000,
'termMonths' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kuahr.com/v1/advances"
payload := strings.NewReader("{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.kuahr.com/v1/advances")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kuahr.com/v1/advances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeId\": \"b2c3d4e5-0000-0000-0000-000000000001\",\n \"amountMinor\": 5000000,\n \"termMonths\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "9f8e7d6c-0000-0000-0000-000000000001",
"employeeId": "b2c3d4e5-0000-0000-0000-000000000001",
"amountMinor": 5000000,
"totalRepayableMinor": 5000000,
"currencyIsoCode": "NGN",
"termMonths": 3,
"status": "Pending",
"disbursedAt": null,
"createdAt": "2026-07-20T11:00:00+00:00"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Your API key, e.g. kua_live_… (or kua_test_… in test mode).
Body
application/json
Response
Created
A salary advance and its lifecycle.
The advance's unique id.
The employee who took the advance.
Principal advanced, in minor units (e.g. kobo).
Total to repay (equals principal — no interest).
ISO-4217 currency code, e.g. NGN.
Number of months to repay over.
One of Pending, Active, Repaid, Defaulted, Cancelled.
When funds landed (null until approved).
When the advance was requested.
⌘I