Skip to main content
GET
/
payouts
/
{payoutId}
Get Payout
curl --request GET \
  --url https://api.fyatu.com/api/v3/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieve details of a specific payout by its payout ID.

​
Path Parameters

ParameterTypeDescription
payoutIdstringThe payout ID

​
Response

FieldTypeDescription
payoutIdstringUnique payout identifier
referencestringYour reference
recipientobjectRecipient information
amountnumberPayout amount
feenumberProcessing fee
totalDebitednumberTotal debited
currencystringCurrency code
descriptionstringDescription
metadataobjectCustom metadata
statusstringPayout status
createdAtstringCreation timestamp

​
Recipient Object

FieldTypeDescription
clientIdstringRecipient’s Fyatu client ID
namestringRecipient’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";
}

​
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

StatusDescription
PENDINGPayout is being processed
COMPLETEDPayout successful
FAILEDPayout failed

​
Error Responses

Error CodeHTTPDescription
RESOURCE_NOT_FOUND404Payout not found
AUTH_TOKEN_INVALID401Invalid or expired token

Authorizations

​
Authorization
string
header
required

JWT access token obtained from /auth/token

Path Parameters

​
payoutId
string
required

Payout ID

Response

Payout retrieved successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
​
data
object
​
meta
object