> ## Documentation Index
> Fetch the complete documentation index at: https://docs.daya.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Legacy: List payouts

> Legacy route for listing settlement payouts

## Overview

Retrieve a paginated list of read-only settlement payouts.

<Info>
  Payouts are legacy read-only settlement artifacts. Merchant-initiated sends use the [Transfers API](/api-reference/transfers/create-transfer).
</Info>

## Authentication

<ParamField header="X-Api-Key" type="string" required>
  Your merchant API key
</ParamField>

## Query Parameters

<ParamField query="type" type="string">
  Filter by payout type

  **Allowed values:** `CRYPTO_PAYOUT`, `NGN_PAYOUT`
</ParamField>

<ParamField query="status" type="string">
  Filter by payout status

  **Allowed values:** `PROCESSING`, `SETTLED`, `FAILED`
</ParamField>

<ParamField query="limit" type="integer">
  Results per page

  **Default:** `20`

  **Max:** `100`
</ParamField>

<ParamField query="page" type="integer">
  Page number (1-indexed)

  **Default:** `1`
</ParamField>

## Request Examples

<CodeGroup>
  ```bash All Payouts theme={null}
  curl --request GET \
    --url 'https://api.daya.co/v1/payouts' \
    --header 'X-Api-Key: YOUR_API_KEY'
  ```

  ```bash By Type theme={null}
  curl --request GET \
    --url 'https://api.daya.co/v1/payouts?type=NGN_PAYOUT' \
    --header 'X-Api-Key: YOUR_API_KEY'
  ```

  ```bash By Status theme={null}
  curl --request GET \
    --url 'https://api.daya.co/v1/payouts?status=SETTLED' \
    --header 'X-Api-Key: YOUR_API_KEY'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.daya.co/v1/payouts?status=SETTLED&page=1&limit=20',
    {
      headers: {
        'X-Api-Key': 'YOUR_API_KEY'
      }
    }
  );
  const data = await response.json();
  ```
</CodeGroup>

## Response

<ResponseField name="data" type="array" required>
  Array of payout objects

  <Expandable title="payout properties">
    <ResponseField name="type" type="string">
      Payout type (`NGN_PAYOUT` or `CRYPTO_PAYOUT`)
    </ResponseField>

    <ResponseField name="id" type="string">
      Unique payout identifier (UUID)
    </ResponseField>

    <ResponseField name="reference" type="string">
      Payout reference string
    </ResponseField>

    <ResponseField name="status" type="string">
      Current status (`PROCESSING`, `SETTLED`, or `FAILED`)
    </ResponseField>

    <ResponseField name="source_currency" type="string">
      Currency funds are sent from (e.g. `USD`)
    </ResponseField>

    <ResponseField name="destination_currency" type="string">
      Currency funds are delivered in (e.g. `NGN`)
    </ResponseField>

    <ResponseField name="source_amount" type="string">
      Amount in source currency
    </ResponseField>

    <ResponseField name="destination_amount" type="string">
      Amount in destination currency
    </ResponseField>

    <ResponseField name="fee" type="string">
      Fee charged for the payout
    </ResponseField>

    <ResponseField name="rate" type="object">
      FX rate applied to the payout

      <Expandable title="rate properties">
        <ResponseField name="side" type="string">
          Rate side (`SELL`)
        </ResponseField>

        <ResponseField name="value" type="string">
          Exchange rate value
        </ResponseField>

        <ResponseField name="captured_at" type="string">
          When the rate was captured (ISO 8601 timestamp)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="recipient" type="object">
      Payout recipient details

      <Expandable title="recipient properties">
        <ResponseField name="id" type="string">
          Recipient identifier (UUID)
        </ResponseField>

        <ResponseField name="type" type="string">
          Recipient type (`BANK_ACCOUNT` or `CRYPTO_ADDRESS`)
        </ResponseField>

        <ResponseField name="bank_account" type="object">
          Bank account details (present for NGN payouts, `null` for crypto payouts)

          <Expandable title="bank_account properties">
            <ResponseField name="account_number" type="string">
              Bank account number
            </ResponseField>

            <ResponseField name="account_name" type="string">
              Account holder name
            </ResponseField>

            <ResponseField name="bank_code" type="string">
              Bank code
            </ResponseField>

            <ResponseField name="bank_name" type="string">
              Bank name
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="crypto_address" type="string">
          Crypto wallet address (present for crypto payouts, `null` for NGN payouts)
        </ResponseField>

        <ResponseField name="created_at" type="string">
          When the recipient was created (ISO 8601 timestamp)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="sender" type="object">
      Entity that initiated the payout

      <Expandable title="sender properties">
        <ResponseField name="type" type="string">
          Sender type (`MERCHANT` or `CUSTOMER`)
        </ResponseField>

        <ResponseField name="id" type="string">
          Sender identifier (UUID)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="tx_hash" type="string">
      On-chain transaction hash (for crypto payouts, `null` for NGN payouts)
    </ResponseField>

    <ResponseField name="created_at" type="string">
      When the payout was created (ISO 8601 timestamp)
    </ResponseField>

    <ResponseField name="settled_at" type="string">
      When the payout settled (ISO 8601 timestamp, `null` if not yet settled)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="page" type="integer" required>
  Current page number
</ResponseField>

<ResponseField name="limit" type="integer" required>
  Results per page
</ResponseField>

<ResponseField name="total" type="integer" required>
  Total number of payouts matching filters
</ResponseField>

<ResponseField name="total_pages" type="integer" required>
  Total number of pages
</ResponseField>

### Success Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": [
      {
        "type": "NGN_PAYOUT",
        "id": "b2c3d4e5-f6a7-8901-bcde-f23456789abc",
        "reference": "PAY-NGN-20250105-001",
        "status": "SETTLED",
        "source_currency": "USD",
        "destination_currency": "NGN",
        "source_amount": "100.00",
        "destination_amount": "155050.00",
        "fee": "1.50",
        "rate": {
          "side": "SELL",
          "value": "1550.50",
          "captured_at": "2025-01-05T15:04:05Z"
        },
        "recipient": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "type": "BANK_ACCOUNT",
          "bank_account": {
            "account_number": "1234567890",
            "account_name": "John Doe",
            "bank_code": "044",
            "bank_name": "Access Bank"
          },
          "crypto_address": null,
          "created_at": "2025-01-05T15:04:05Z"
        },
        "sender": {
          "type": "MERCHANT",
          "id": "c3d4e5f6-a7b8-9012-cdef-345678901abc"
        },
        "tx_hash": null,
        "created_at": "2025-01-05T15:04:05Z",
        "settled_at": "2025-01-05T15:10:00Z"
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 42,
    "total_pages": 3
  }
  ```
</ResponseExample>

## Next Steps

<CardGroup cols={2}>
  <Card title="Get Payout" icon="magnifying-glass" href="/api-reference/payouts/get-payout">
    Get a specific payout by ID
  </Card>

  <Card title="List Deposits" icon="arrow-down" href="/api-reference/deposits/list-deposits">
    View incoming deposits
  </Card>
</CardGroup>