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

# Search your payouts



## OpenAPI

````yaml get /payouts/search
openapi: 3.0.0
info:
  title: Customer API
  version: v1
servers:
  - url: https://sandbox-api.fedapay.com/v1
  - url: https://api.fedapay.com/v1
security: []
paths:
  /payouts/search:
    get:
      summary: Search your payouts
      responses:
        '200':
          description: List of payouts.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Payout ID.
                    reference:
                      type: string
                      description: Payout reference.
                    amount:
                      type: integer
                      description: Payout amount.
                    status:
                      type: string
                      description: >-
                        Payout status (e.g., 'pending', 'scheduled', 'sent',
                        'failed').
                    customer_id:
                      type: integer
                      description: Customer ID associated with the payout.
                    currency_id:
                      type: integer
                      description: Currency ID associated with the payout.
                    mode:
                      type: string
                      description: Payout mode.
                    last_error_code:
                      type: string
                      description: Last error code encountered during the payout.
                    commission:
                      type: integer
                      description: Payout commission.
                    fees:
                      type: integer
                      description: Payout fees.
                    fixed_commission:
                      type: integer
                      description: Fixed commission applied to the payout.
                    amount_transferred:
                      type: integer
                      description: Amount transferred to the beneficiary.
                    amount_debited:
                      type: integer
                      description: Amount debited from the payer.
                    created_at:
                      type: string
                      format: date-time
                      description: Date and time of payout creation.
                    updated_at:
                      type: string
                      format: date-time
                      description: Date and time of last payout update.
                    scheduled_at:
                      type: string
                      format: date-time
                      description: Date and time the payout is scheduled to be sent.
                    sent_at:
                      type: string
                      format: date-time
                      description: Date and time the payout was sent.
                    failed_at:
                      type: string
                      format: date-time
                      description: Date and time the payout failed.
                    deleted_at:
                      type: string
                      format: date-time
                      description: Date and time of payout deletion.
                    metadata:
                      type: object
                      description: Additional metadata related to the payout.
                    custom_metadata:
                      type: object
                      description: Custom metadata associated with the payout.
                    payment_method_id:
                      type: integer
                      description: Payment method ID used for the payout.
                    transaction_key:
                      type: string
                      description: Unique key associated with the payout.
                    merchant_reference:
                      type: string
                      description: Merchant reference provided for the payout.
                    account_id:
                      type: integer
                      description: Account ID associated with the payout.
                    balance_id:
                      type: integer
                      description: Balance ID associated with the payout.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          label: NodeJs
          source: >-
            const { FedaPay, Payout } = require('fedapay');

            /* Replace YOUR_SECRETE_API_KEY with your real API key */

            FedaPay.setApiKey("YOUR_SECRETE_API_KEY");

            /* Specify whether you want to run your query in test or live mode
            */

            FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');

            /* Show payouts */

            const payout = await Payout.all(params = {}, headers = {});
        - lang: PHP
          source: |-
            \FedaPay\Fedapay::setApiKey(MY_API_KEY);
            $payout = \FedaPay\Payout::all(params = {}, header = {});
        - lang: Ruby
          source: |-
            require 'fedapay';
            # configure FedaPay library
            FedaPay.api_key = '' # Your secret api key
            FedaPay.environment = '' # sandbox or live
            payouts = FedaPay::Payout.list;
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````