Payout Status
curl --request GET \
--url https://quickei.io/api/partner/sandbox/v1/payout/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://quickei.io/api/partner/sandbox/v1/payout/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://quickei.io/api/partner/sandbox/v1/payout/{id}', 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://quickei.io/api/partner/sandbox/v1/payout/{id}",
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://quickei.io/api/partner/sandbox/v1/payout/{id}"
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://quickei.io/api/partner/sandbox/v1/payout/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://quickei.io/api/partner/sandbox/v1/payout/{id}")
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{
"payout.payout_id": "<string>",
"payout.reference": "<string>",
"payout.amount": 123,
"payout.currency": "<string>",
"payout.fee": 123,
"payout.total_deducted": 123,
"payout.exchange_rate": 123,
"payout.receiver_amount": 123,
"payout.receiver_currency": "<string>",
"payout.status": "<string>",
"payout.description": "<string>",
"payout.trx_id": "<string>",
"payout.created_at": "<string>",
"payout.processed_at": "<string>"
}Partner API
Payout Status
Check the status of a payout
GET
/
api
/
partner
/
sandbox
/
v1
/
payout
/
{id}
Payout Status
curl --request GET \
--url https://quickei.io/api/partner/sandbox/v1/payout/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://quickei.io/api/partner/sandbox/v1/payout/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://quickei.io/api/partner/sandbox/v1/payout/{id}', 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://quickei.io/api/partner/sandbox/v1/payout/{id}",
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://quickei.io/api/partner/sandbox/v1/payout/{id}"
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://quickei.io/api/partner/sandbox/v1/payout/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://quickei.io/api/partner/sandbox/v1/payout/{id}")
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{
"payout.payout_id": "<string>",
"payout.reference": "<string>",
"payout.amount": 123,
"payout.currency": "<string>",
"payout.fee": 123,
"payout.total_deducted": 123,
"payout.exchange_rate": 123,
"payout.receiver_amount": 123,
"payout.receiver_currency": "<string>",
"payout.status": "<string>",
"payout.description": "<string>",
"payout.trx_id": "<string>",
"payout.created_at": "<string>",
"payout.processed_at": "<string>"
}Retrieve the current status and details of a payout.
Success Response
Path Parameters
string
required
The
payout_id returned from the Execute Payout endpoint (e.g. POAB1C2D3E).Example Request
curl -X GET https://quickei.io/api/partner/sandbox/v1/payout/POAB1C2D3E \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Success Response 200
{
"message": {
"success": ["Payout details."]
},
"data": {
"payout": {
"payout_id": "POAB1C2D3E",
"reference": "PAYROLL-2026-03-001",
"amount": 100.00,
"currency": "EUR",
"fee": 2.50,
"total_deducted": 102.50,
"exchange_rate": 655.957,
"receiver_amount": 65595.70,
"receiver_currency": "XAF",
"status": "completed",
"description": "March 2026 salary",
"trx_id": "PP8274619350",
"created_at": "2026-03-29T14:01:15+00:00",
"processed_at": "2026-03-29T14:01:15+00:00"
}
}
}
Payout Object Fields
string
Unique payout identifier (format:
PO + 8 alphanumeric characters).string
Your internal reference for this payout.
number
The amount sent (before fees), in
currency.string
The sender currency code.
number
Total fee charged.
number
Total debited from your merchant wallet (
amount + fee).number
Applied exchange rate from sender to receiver currency.
number
Amount credited to the recipient’s wallet.
string
The recipient’s currency code.
string
Current payout status:
completed, pending, or failed.string
Description provided when creating the payout. May be
null.string
Quickei internal transaction ID. May be
null if the payout failed before a transaction was created.string
ISO 8601 timestamp when the payout was created.
string
ISO 8601 timestamp when the payout was processed.
null if still pending or failed.Payout Statuses
| Status | Description |
|---|---|
completed | Payout executed successfully. Funds are in the recipient’s wallet. |
pending | Payout is being processed (rare, most payouts complete instantly). |
failed | Payout failed. Merchant wallet was not debited. |
Error Responses
| Status | Message | Cause |
|---|---|---|
400 | Payout not found. | Payout ID does not exist or does not belong to your merchant account |
401 | Invalid API credentials. | Bad or missing Bearer token |

