> ## 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.

# Get Payout

> Get details of a specific payout — amount, recipient, charges, net amount, and status. GET /payouts/{id}.

## 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

<CodeGroup>
  ```php PHP theme={null}
  <?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";
  }
  ```

  ```javascript Node.js theme={null}
  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}`);
  }
  ```
</CodeGroup>

## Example Response

```json theme={null}
{
  "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 |


## OpenAPI

````yaml v3/openapi.json GET /payouts/{payoutId}
openapi: 3.1.0
info:
  title: FYATU API v3
  description: >-
    FYATU API v3 with JWT authentication for Collections, Payouts, and Card
    Issuing.
  version: 3.0.0
  contact:
    name: FYATU Support
    url: https://fyatu.com
    email: support@fyatu.com
servers:
  - url: https://api.fyatu.com/api/v3
    description: Production
security: []
tags:
  - name: Authentication
    description: JWT token management endpoints
  - name: Account
    description: Business account, wallet, and address management
  - name: Collections
    description: Accept payments from customers via checkout sessions
  - name: Refunds
    description: Issue refunds for completed collections
  - name: Payouts
    description: Send money to Fyatu account holders
  - name: Cardholders
    description: Cardholder management for card issuing programs
  - name: Cards
    description: Issue, fund, freeze, and manage virtual cards
  - name: Webhooks
    description: Webhook configuration and management
paths:
  /payouts/{payoutId}:
    get:
      tags:
        - Payouts
      summary: Get Payout
      description: Retrieve details of a specific payout by its payout ID.
      operationId: getPayout
      parameters:
        - name: payoutId
          in: path
          required: true
          schema:
            type: string
          description: Payout ID
      responses:
        '200':
          description: Payout retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - BearerAuth: []
components:
  schemas:
    PayoutDetailResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        status:
          type: integer
          example: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/PayoutDetail'
        meta:
          $ref: '#/components/schemas/Meta'
    PayoutDetail:
      type: object
      properties:
        payoutId:
          type: string
          description: Unique payout identifier
        reference:
          type: string
        recipient:
          type: object
          properties:
            clientId:
              type: string
            name:
              type: string
        amount:
          type: number
        fee:
          type: number
        totalDebited:
          type: number
        currency:
          type: string
        description:
          type: string
        metadata:
          type: object
        status:
          type: string
        createdAt:
          type: string
          format: date-time
    Meta:
      type: object
      properties:
        requestId:
          type: string
          description: Unique request ID for tracking
          example: req_abc123def456
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the response
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        status:
          type: integer
          example: 401
        message:
          type: string
          example: Invalid credentials
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code for programmatic handling
          example: AUTH_INVALID_CREDENTIALS
        details:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: Validation error details (for VALIDATION_ERROR)
    ValidationError:
      type: object
      properties:
        field:
          type: string
          description: Field that failed validation
          example: appId
        message:
          type: string
          description: Validation error message
          example: AppId is required
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            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'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            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'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token obtained from /auth/token

````