# List all payouts

Endpoint: GET /payouts
Version: 1.0.0
Security: JWT

## Query parameters:

  - `beneficiary_id` (string)
    The unique identifier of the beneficiary
    Example: "bene_5JU9yv0lGSUP"

  - `status` (string)
    Status of payout to filter
    Enum: "in_progress", "success", "failed", "action_required", "cancelled", "under_review"

  - `before` (string)
    ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-02-18T12:03:44Z"

  - `after` (string)
    ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-01-18T12:03:44Z"

  - `per_page` (integer)
    Number of resources per page. Should be between 1 and 100.

  - `page` (integer)
    Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    The unique identifier for the payin.
    Example: "payout_DdWp_HUbOnlg"

  - `data.status` (string)
    The status of the payout.
    Example: "success"

  - `data.destination_amount` (number)
    The amount the beneficiary will receive, expressed in the smallest unit of the specified currency (e.g., cents for USD, paisa for INR). 
      For example, 1000 represents $10.00 in USD. The actual currency is determined by the currency field. Note: "cents" is used generically to denote 
      the minimal currency unit, not necessarily USD.
    Example: 1000

  - `data.destination_currency` (string)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, USD.
    Example: "USD"

  - `data.source_amount` (number)
    The amount you intend to send, also specified in the smallest unit of the selected currency. For example, 1000 equates to $10.00 in USD. The currency field determines which currency is used. As with destination_amount, "cents" is a placeholder for the minimal unit, not specifically USD.
    Example: 1000

  - `data.source_currency` (string)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, USD.
    Example: "USD"

  - `data.beneficiary_id` (string)
    The unique identifier for the beneficiary.
    Example: "bene_5JU9yv0lGSUP"

  - `data.documents` (array)
    The attached documents for the payout.

  - `data.documents.id` (string)
    The unique identifier for the Document.
    Example: "doc_nYUqLpuYQ0M8"

  - `data.documents.type` (string)
    The type of the Document.
    Example: "invoice"

  - `data.documents.status` (string)
    Enum: "pending", "uploaded", "rejected", "approved"

  - `data.documents.rfi_doc_id` (string,null)
    The unique identifier for the RFI Document. This will be null if the document is not an RFI Document.
    Example: "rfidoc_nYUqLpuYQ0M8"

  - `data.purpose_code` (string)
    Purpose code for why you want to receive this payment
    Example: "S0017"

  - `data.mid_market_rate` (number)
    The mid-market rate at the time of payout creation.
    Example: 1

  - `data.fees` (object)
    The fees applied to this payout

  - `data.fees.fx` (object)
    The foreign exchange fees applied to the payout

  - `data.fees.fx.currency` (string)
    The currency code for the FX fee
    Example: "USD"

  - `data.fees.fx.amount` (number)
    The amount of the FX fee
    Example: 200

  - `data.fees.transaction` (object)
    The transaction fees applied to the payout

  - `data.fees.transaction.currency` (string)
    The currency code for the transaction fee
    Example: "USD"

  - `data.fees.transaction.amount` (number)
    The amount of the transaction fee
    Example: 100

  - `data.created_at` (string)
    Timestamp representing when the payout was created
    Example: "2021-06-01T12:00:00Z"

  - `data.updated_at` (string)
    Timestamp representing when the payout was last updated
    Example: "2021-06-01T12:00:00Z"

  - `page_meta` (object)

  - `page_meta.current` (integer)
    The current page number.
    Example: 2

  - `page_meta.previous` (integer,null)
    The previous page number.
    Example: 1

  - `page_meta.next` (integer,null)
    The next page number.
    Example: 3

  - `page_meta.per_page` (integer)
    The number of items per page.
    Example: 20

  - `page_meta.pages` (integer)
    The total number of pages.
    Example: 10

  - `page_meta.count` (integer)
    The total number of items.
    Example: 200