Get Payout
curl --request GET \
--url https://api.fyatu.com/api/v3/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3/payouts/{payoutId}', 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.fyatu.com/api/v3/payouts/{payoutId}",
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://api.fyatu.com/api/v3/payouts/{payoutId}"
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://api.fyatu.com/api/v3/payouts/{payoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/payouts/{payoutId}")
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{
"success": true,
"status": 200,
"message": "<string>",
"data": {
"payoutId": "<string>",
"reference": "<string>",
"recipient": {
"clientId": "<string>",
"name": "<string>"
},
"amount": 123,
"fee": 123,
"totalDebited": 123,
"currency": "<string>",
"description": "<string>",
"metadata": {},
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 404,
"message": "Wallet not found",
"error": {
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}Payouts
Get Payout
Get details of a specific payout — amount, recipient, charges, net amount, and status. GET /payouts/.
GET
/
payouts
/
{payoutId}
Get Payout
curl --request GET \
--url https://api.fyatu.com/api/v3/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3/payouts/{payoutId}', 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.fyatu.com/api/v3/payouts/{payoutId}",
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://api.fyatu.com/api/v3/payouts/{payoutId}"
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://api.fyatu.com/api/v3/payouts/{payoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/payouts/{payoutId}")
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{
"success": true,
"status": 200,
"message": "<string>",
"data": {
"payoutId": "<string>",
"reference": "<string>",
"recipient": {
"clientId": "<string>",
"name": "<string>"
},
"amount": 123,
"fee": 123,
"totalDebited": 123,
"currency": "<string>",
"description": "<string>",
"metadata": {},
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 404,
"message": "Wallet not found",
"error": {
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}Overview
Retrieve details of a specific payout by its payout ID.Path Parameters
| Parameter | Type | Description |
|---|---|---|
payoutId | string | The payout ID |
Response
| Field | Type | Description |
|---|---|---|
payoutId | string | Unique payout identifier |
reference | string | Your reference |
recipient | object | Recipient information |
amount | number | Payout amount |
fee | number | Processing fee |
totalDebited | number | Total debited |
currency | string | Currency code |
description | string | Description |
metadata | object | Custom metadata |
status | string | Payout status |
createdAt | string | Creation timestamp |
Recipient Object
| Field | Type | Description |
|---|---|---|
clientId | string | Recipient’s Fyatu client ID |
name | string | Recipient’s name |
Example Usage
<?php
$payoutId = 'pay_a1b2c3d4e5f6';
$response = file_get_contents(
"https://api.fyatu.com/api/v3/payouts/{$payoutId}",
false,
stream_context_create([
'http' => [
'method' => 'GET',
'header' => 'Authorization: Bearer ' . $accessToken
]
])
);
$result = json_decode($response, true);
if ($result['success']) {
$payout = $result['data'];
echo "Payout Status: {$payout['status']}\n";
echo "Recipient: {$payout['recipient']['name']}\n";
echo "Amount: {$payout['amount']} {$payout['currency']}\n";
}
const payoutId = 'pay_a1b2c3d4e5f6';
const response = await fetch(
`https://api.fyatu.com/api/v3/payouts/${payoutId}`,
{
headers: {
'Authorization': `Bearer ${accessToken}`
}
}
);
const result = await response.json();
if (result.success) {
const payout = result.data;
console.log(`Payout Status: ${payout.status}`);
console.log(`Recipient: ${payout.recipient.name}`);
console.log(`Amount: ${payout.amount} ${payout.currency}`);
}
Example Response
{
"success": true,
"status": 200,
"message": "Payout retrieved successfully",
"data": {
"payoutId": "pay_a1b2c3d4e5f6",
"reference": "PAY-0001",
"recipient": {
"clientId": "clt_a1b2c3d4e5f6",
"name": "Alice Example"
},
"amount": 100.00,
"fee": 0.50,
"totalDebited": 100.50,
"currency": "USD",
"description": "Staff Payment",
"metadata": {
"reference": "PAYROLL-001"
},
"status": "COMPLETED",
"createdAt": "2026-01-08T10:30:00+00:00"
},
"meta": {
"requestId": "req_getpayout123",
"timestamp": "2026-01-08T11:00:00+00:00"
}
}
Status Values
| Status | Description |
|---|---|
PENDING | Payout is being processed |
COMPLETED | Payout successful |
FAILED | Payout failed |
Error Responses
| Error Code | HTTP | Description |
|---|---|---|
RESOURCE_NOT_FOUND | 404 | Payout not found |
AUTH_TOKEN_INVALID | 401 | Invalid or expired token |
Authorizations
JWT access token obtained from /auth/token
Path Parameters
Payout ID
⌘I

