Skip to main content
GET
/
payouts
List Payouts
curl --request GET \
  --url https://api.fyatu.com/api/v3/payouts \
  --header 'Authorization: Bearer <token>'
{
  "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": {
      "page": 123,
      "perPage": 123,
      "totalItems": 123,
      "totalPages": 123
    }
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

​
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";

​
Example Response

{
  "success": true,
  "status": 200,
  "message": "Payouts retrieved successfully",
  "data": {
    "payouts": [
      {
        "payoutId": "PAY678A1B2C3D4E5F6",
        "reference": "PAY-20260108-001",
        "recipient": {
          "clientId": "F12345678",
          "name": "John Doe"
        },
        "amount": 100.00,
        "fee": 0.50,
        "currency": "USD",
        "status": "COMPLETED",
        "createdAt": "2026-01-08T10:30:00+00:00"
      },
      {
        "payoutId": "PAY678B2C3D4E5F6G7",
        "reference": "PAY-20260108-002",
        "recipient": {
          "clientId": "F87654321",
          "name": "Jane Smith"
        },
        "amount": 75.00,
        "fee": 0.50,
        "currency": "USD",
        "status": "COMPLETED",
        "createdAt": "2026-01-08T11:00: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=F12345678

​
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