Skip to main content
GET
/
payouts
List Payouts
curl --request GET \
  --url https://api.fyatu.com/api/v3/payouts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.fyatu.com/api/v3/payouts"

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', 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",
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"

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")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.fyatu.com/api/v3/payouts")

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": {
    "payouts": [
      {
        "payoutId": "<string>",
        "reference": "<string>",
        "recipient": {
          "clientId": "<string>",
          "name": "<string>"
        },
        "amount": 123,
        "fee": 123,
        "currency": "<string>",
        "status": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "currentPage": 123,
      "itemsPerPage": 123,
      "totalItems": 123,
      "totalPages": 123
    }
  },
  "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"
}
}

Overview

Retrieve a paginated list of payouts with optional filtering.

Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20, max: 100)
statusstringFilter by status (PENDING, COMPLETED, FAILED)
referencestringSearch by reference (partial match)
recipientstringSearch by recipient (client ID or name)
dateFromstringFilter from date (YYYY-MM-DD)
dateTostringFilter to date (YYYY-MM-DD)

Response

FieldTypeDescription
payoutsarrayList of payout objects
paginationobjectPagination info

Payout Object (Summary)

FieldTypeDescription
payoutIdstringUnique payout identifier
referencestringYour reference
recipientobjectRecipient info (clientId, name)
amountnumberPayout amount
feenumberProcessing fee
currencystringCurrency code
statusstringPayout status
createdAtstringCreation time

Example Usage

<?php
// Get this month's payouts
$params = http_build_query([
    'dateFrom' => date('Y-m-01'),
    'dateTo' => date('Y-m-d'),
    'status' => 'COMPLETED',
    'limit' => 100
]);

$response = file_get_contents(
    "https://api.fyatu.com/api/v3/payouts?{$params}",
    false,
    stream_context_create([
        'http' => [
            'method' => 'GET',
            'header' => 'Authorization: Bearer ' . $accessToken
        ]
    ])
);

$result = json_decode($response, true);

$totalPaidOut = 0;
$totalFees = 0;

foreach ($result['data']['payouts'] as $payout) {
    $totalPaidOut += $payout['amount'];
    $totalFees += $payout['fee'];
    echo "{$payout['reference']}: {$payout['amount']} to {$payout['recipient']['name']} - {$payout['status']}\n";
}

echo "\nTotal paid out: $totalPaidOut USD\n";
echo "Total fees: $totalFees USD\n";
echo "Total debited: " . ($totalPaidOut + $totalFees) . " USD\n";
// Get this month's payouts
const now = new Date();
const params = new URLSearchParams({
  dateFrom: `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, '0')}-01`,
  dateTo: now.toISOString().split('T')[0],
  status: 'COMPLETED',
  limit: '100'
});

const response = await fetch(
  `https://api.fyatu.com/api/v3/payouts?${params}`,
  {
    headers: {
      'Authorization': `Bearer ${accessToken}`
    }
  }
);

const result = await response.json();

let totalPaidOut = 0;
let totalFees = 0;

for (const payout of result.data.payouts) {
  totalPaidOut += payout.amount;
  totalFees += payout.fee;
  console.log(`${payout.reference}: ${payout.amount} to ${payout.recipient.name} - ${payout.status}`);
}

console.log(`\nTotal paid out: ${totalPaidOut} USD`);
console.log(`Total fees: ${totalFees} USD`);
console.log(`Total debited: ${totalPaidOut + totalFees} USD`);

Example Response

{
  "success": true,
  "status": 200,
  "message": "Payouts retrieved successfully",
  "data": {
    "payouts": [
      {
        "payoutId": "pay_a1b2c3d4e5f6",
        "reference": "PAY-0001",
        "recipient": {
          "clientId": "clt_a1b2c3d4e5f6",
          "name": "Alice Example"
        },
        "amount": 100.00,
        "fee": 0.50,
        "currency": "USD",
        "status": "COMPLETED",
        "createdAt": "2026-01-08T10:30:00+00:00"
      }
    ],
    "pagination": {
      "currentPage": 1,
      "itemsPerPage": 20,
      "totalItems": 45,
      "totalPages": 3
    }
  },
  "meta": {
    "requestId": "req_paylist123",
    "timestamp": "2026-01-08T12:00:00+00:00"
  }
}

Filtering Examples

By Recipient

GET /payouts?recipient=clt_a1b2c3d4e5f6

Failed Payouts

GET /payouts?status=FAILED

Search by Reference

GET /payouts?reference=PAY-20260108

Date Range

GET /payouts?dateFrom=2026-01-01&dateTo=2026-01-31

Export for Accounting

Use date filtering and pagination to export payout data for reconciliation:
<?php
// Export all payouts for a month
$allPayouts = [];
$page = 1;

do {
    $params = http_build_query([
        'dateFrom' => '2026-01-01',
        'dateTo' => '2026-01-31',
        'status' => 'COMPLETED',
        'page' => $page,
        'limit' => 100
    ]);

    $response = file_get_contents(
        "https://api.fyatu.com/api/v3/payouts?{$params}",
        false,
        stream_context_create([
            'http' => [
                'method' => 'GET',
                'header' => 'Authorization: Bearer ' . $accessToken
            ]
        ])
    );

    $result = json_decode($response, true);
    $allPayouts = array_merge($allPayouts, $result['data']['payouts']);
    $page++;

} while ($page <= $result['data']['pagination']['totalPages']);

// Now $allPayouts contains all payouts for the month
Use payout reports for payroll reconciliation, tax reporting, and financial audits.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
status
enum<string>
Available options:
PENDING,
COMPLETED,
FAILED
reference
string

Search by reference (partial match)

recipient
string

Search by recipient (client ID or name)

dateFrom
string<date>

Filter from date (YYYY-MM-DD)

dateTo
string<date>

Response

Payouts retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object