---
title: "Get Payout List"
method: GET
path: "/v1/payouts"
---

# Get Payout List

`GET /v1/payouts`

Retrieve a list of payouts with filtering and pagination options

## Query parameters

- `search` string
- `payout_status` 'pending' | 'on_hold' | 'in_transit' | 'deposited' | 'returned' | 'cancelled'
- `sort_by` 'created_at' | 'net_amount'
- `order` 'asc' | 'desc'
- `provider` 'paymongo_central_hub' | 'unionbank'
- `created_at.between` string
- `limit` integer
- `after` string
- `before` string

## Response `200`

Successful response

- object
  - `total_amount` integer — Total amount of all payouts
  - `total_per_currency` object — Total amount breakdown by currency
    - `PHP` object
      - `total_amount` integer — Total payout amount for this currency
  - `total_records` integer — Total number of payout records
  - `pagination` object
    - `next_cursor` string — Cursor for fetching next page of results
    - `prev_cursor` string — Cursor for fetching previous page of results
  - `data` object[] — List of payouts
    - `id` string — The payout ID
    - `type` string — The resource type
    - `attributes` object
      - `amount` integer — Original payout amount
      - `adjustment_amount` integer — Adjustment amount applied to the payout
      - `bank_account_name` string — Name of the receiving bank account
      - `bank_account_number` string — Number of the receiving bank account
      - `bank_name` string — Name of the receiving bank
      - `converted_net_amount` integer — Net payout amount after conversion
      - `currency` string — Currency code of the payout
      - `currency_exchange_rate` object — Currency exchange rate details
        - `from_currency` string — Source currency code
        - `from_value` integer — Source currency value
        - `to_currency` string — Target currency code
        - `to_value` integer — Target currency value
      - `description` string — Description of the payout
      - `digital_tax` integer — Digital tax amount
      - `digital_withholding_vat_amount` integer — Digital withholding VAT amount
      - `dispute_amount` integer — Total dispute amount deducted from payout
      - `fee` integer — Payout processing fee
      - `foreign_fee` integer — Foreign transaction fee
      - `last_payout_transfer` object — Details of the last payout transfer (null if no transfer yet)
        - `id` string — The transfer ID
        - `channel` string — The channel used for the transfer
        - `origin` string — The origin of the transfer (e.g., api, dashboard)
        - `provider` string — The payment provider
        - `provider_reference_number` string — Reference number from the provider
        - `reference_number` string — Internal reference number for the transfer
        - `status` 'to_do' | 'pending' | 'processing' | 'deposited' | 'returned' — The current status of the transfer
        - `error_code` string — Error code if the transfer failed
        - `error_message` string — Error message if the transfer failed
      - `net_amount` integer — Net payout amount after deductions
      - `organization` object — Organization details
        - `id` string — Organization ID
        - `business_handle` string — Business handle
        - `trade_name` string — Trade name of the organization
      - `provider` string — Payout provider name
      - `refund_amount` integer — Total refund amount deducted from payout
      - `status` 'pending' | 'on_hold' | 'in_transit' | 'deposited' | 'returned' | 'cancelled' — Current status of the payout
      - `tax_amount` integer — Total tax amount
      - `taxes` object[] — List of taxes applied to the payout
        - `amount` integer — Tax amount
        - `currency` string — Currency code
        - `inclusive` boolean — Whether tax is inclusive in the amount
        - `name` string — Tax name
        - `type` string — Tax type (e.g., vat, withholding_tax)
        - `value` string — Tax value (e.g., basis points)
      - `created_at` integer — Unix timestamp when the payout was created
      - `status_updated_at` integer — Unix timestamp when the payout status was last updated
      - `updated_at` integer — Unix timestamp when the payout was last updated

---

[API](https://skmtc.net/paymongo/apis/paymongo-api.md) · [All operations](https://skmtc.net/paymongo/apis/paymongo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymongo/paymongo-api/versions/c18f9a027b2c/schema)