Get a payout
curl --request GET \
--url https://api.spendin.app/v1/payouts/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.spendin.app/v1/payouts/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.spendin.app/v1/payouts/{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://api.spendin.app/v1/payouts/{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 => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.spendin.app/v1/payouts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.spendin.app/v1/payouts/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spendin.app/v1/payouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a3f1c2d4-...",
"tenant_id": "<string>",
"status": "CREATED",
"merchant_reference": {},
"notification_url": {},
"destination_type": "MOBILE_MONEY",
"destination_country": "GH",
"destination_currency": "GHS",
"destination_amount": 500,
"destination_account_unique": "0244000000",
"destination_provider_name": "MTN",
"destination_provider_code": "044",
"destination_account_name": {},
"settlement_currency": "USDT",
"settlement_amount": 28.5,
"exchange_rate": 17.543,
"platform_fee_amount": 1.5,
"platform_fee_currency": "USDT",
"network_fee_amount": 0.5,
"network_fee_currency": "USDT",
"total_fee_amount": 2,
"total_fee_currency": "USDT",
"is_refunded": false,
"payment_instruction": {
"id": "b7e2f1a0-...",
"rail": "CRYPTO",
"account_unique": "TXyz1234...abc",
"provider_name": "USDT (TRC-20)",
"network": "TRC20",
"expected_amount": 28.5,
"expected_currency": "USDT",
"payment_status": "UNPAID",
"expires_at": "2026-03-06T15:00:00.000Z",
"paid_at": "2026-03-06T14:38:14.000Z"
},
"status_timeline": [
{
"from_status": "CREATED",
"to_status": "CREATED",
"triggered_by": "SYSTEM",
"reason_code": "PAYOUT_CREATED",
"reason_detail": {},
"metadata": {},
"created_at": "2026-03-06T14:30:00.000Z"
}
],
"created_at": "2026-03-06T14:30:00.000Z",
"updated_at": "2026-03-06T14:30:01.000Z"
}payouts
Get a payout
Includes the nested active payment instruction and the full status timeline — every transition with its reason code.
GET
/
v1
/
payouts
/
{id}
Get a payout
curl --request GET \
--url https://api.spendin.app/v1/payouts/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.spendin.app/v1/payouts/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.spendin.app/v1/payouts/{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://api.spendin.app/v1/payouts/{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 => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.spendin.app/v1/payouts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.spendin.app/v1/payouts/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spendin.app/v1/payouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a3f1c2d4-...",
"tenant_id": "<string>",
"status": "CREATED",
"merchant_reference": {},
"notification_url": {},
"destination_type": "MOBILE_MONEY",
"destination_country": "GH",
"destination_currency": "GHS",
"destination_amount": 500,
"destination_account_unique": "0244000000",
"destination_provider_name": "MTN",
"destination_provider_code": "044",
"destination_account_name": {},
"settlement_currency": "USDT",
"settlement_amount": 28.5,
"exchange_rate": 17.543,
"platform_fee_amount": 1.5,
"platform_fee_currency": "USDT",
"network_fee_amount": 0.5,
"network_fee_currency": "USDT",
"total_fee_amount": 2,
"total_fee_currency": "USDT",
"is_refunded": false,
"payment_instruction": {
"id": "b7e2f1a0-...",
"rail": "CRYPTO",
"account_unique": "TXyz1234...abc",
"provider_name": "USDT (TRC-20)",
"network": "TRC20",
"expected_amount": 28.5,
"expected_currency": "USDT",
"payment_status": "UNPAID",
"expires_at": "2026-03-06T15:00:00.000Z",
"paid_at": "2026-03-06T14:38:14.000Z"
},
"status_timeline": [
{
"from_status": "CREATED",
"to_status": "CREATED",
"triggered_by": "SYSTEM",
"reason_code": "PAYOUT_CREATED",
"reason_detail": {},
"metadata": {},
"created_at": "2026-03-06T14:30:00.000Z"
}
],
"created_at": "2026-03-06T14:30:00.000Z",
"updated_at": "2026-03-06T14:30:01.000Z"
}Authorizations
Path Parameters
Response
Payout found
Example:
"a3f1c2d4-..."
Available options:
CREATED, PENDING_PAYMENT, PAYMENT_RECEIVED, PROCESSING, SUCCESSFUL, FAILED, EXPIRED Per-payout webhook override, if set
Available options:
MOBILE_MONEY, BANK_ACCOUNT, CRYPTO_WALLET Example:
"GH"
Example:
"GHS"
Example:
500
Example:
"0244000000"
Example:
"MTN"
Bank code / mobile money code the processor routes on. Null for crypto.
Example:
"044"
Example:
"USDT"
Set by generate-payment-instructions job
Example:
28.5
Example:
17.543
Example:
1.5
Example:
"USDT"
Example:
0.5
Example:
"USDT"
Example:
2
Example:
"USDT"
Example:
false
Current active payment instruction, if generated (null until the cronjob runs)
Show child attributes
Show child attributes
Status transition history, oldest → newest
Show child attributes
Show child attributes
Example:
"2026-03-06T14:30:00.000Z"
Example:
"2026-03-06T14:30:01.000Z"