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

# Get payout details

> Retrieves detailed information about a specific payout.



## OpenAPI

````yaml /api-reference/openapi.yaml get /payouts/{uuid}
openapi: 3.0.3
info:
  title: Streamlined API
  description: >
    Access customers, customer applications, customer groups, products, payouts,
    invoices, transactions, and deposit links programmatically through this API,
    and receive webhooks when deposit links change. All requests must be
    authenticated with an API key.
  version: 1.6.0
  license:
    name: Proprietary
    url: https://streamlinedpayments.com/terms
servers:
  - url: https://api.staging.streamlinedpayments.com/api/v1
    description: Sandbox
  - url: https://api.streamlinedpayments.com/api/v1
    description: Production
security:
  - AppIdAuth: []
    ApiKeyAuth: []
tags:
  - name: Customers
    description: Create, update and delete the businesses you sell to.
  - name: Customer applications
    description: >-
      List the applications your customers submit, and approve them. Approving
      can also set net terms and export the customer to Shopify. See [Approve
      customer applications](/guides/customer-applications).
  - name: Customer groups
    description: >-
      Organize customers into groups and manage who's in each one. A group can
      be linked to a Shopify B2B company.
  - name: Customer files
    description: Upload and manage files attached to a customer.
  - name: Customer addresses
    description: Manage a customer's addresses and choose their default billing address.
  - name: Orders
    description: Create orders, add and remove line items, and schedule them.
  - name: Invoices
    description: Create invoices from orders, then list, look up and update them.
  - name: Transactions
    description: List transactions and look one up.
  - name: Payouts
    description: List payouts, including pending ones, and look one up.
  - name: Products
    description: >-
      Create and update the products and services you sell, import them in bulk,
      and merge duplicates.
  - name: Deposit links
    description: Collect money from a customer before an invoice exists.
  - name: Webhooks
    description: >-
      Register HTTPS endpoints to receive events when something changes. See
      [Webhooks](/guides/webhooks) for signatures, retries and delivery
      guarantees.
paths:
  /payouts/{uuid}:
    get:
      tags:
        - Payouts
      summary: Get payout details
      description: Retrieves detailed information about a specific payout.
      operationId: getPayoutDetails
      parameters:
        - name: uuid
          in: path
          description: The UUID of the payout to retrieve
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Payout not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Payout not found
components:
  schemas:
    PayoutDetail:
      type: object
      properties:
        payout:
          type: object
          properties:
            uuid:
              type: string
              format: uuid
            payout_date:
              type: string
            total:
              type: integer
            currency:
              type: string
              enum:
                - USD
                - CAD
                - GBP
                - EUR
                - AUD
                - JPY
                - INR
              description: Currency code
            disbursement_amount:
              type: integer
            disbursement_fee_amount:
              type: integer
            settlement_type:
              type: string
            masked_account_number:
              type: string
            account_number_last_4:
              type: string
            institution_name:
              type: string
            status:
              type: string
              enum:
                - paid
                - pending
            payments:
              type: array
              items:
                $ref: '#/components/schemas/Payment'
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    Payment:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        type:
          type: string
        amount:
          type: integer
        fee:
          type: integer
        currency:
          type: string
          enum:
            - USD
            - CAD
            - GBP
            - EUR
            - AUD
            - JPY
            - INR
          description: Currency code
        payment_source:
          type: string
        created_at:
          type: string
        linked_invoice_identifiers:
          type: array
          items:
            type: string
        invoice_token:
          type: string
        payment_url:
          type: string
        customer:
          $ref: '#/components/schemas/PaymentCustomer'
    PaymentCustomer:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        customer_name:
          type: string
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            AuthenticationRequired:
              value:
                error: Authentication required
                message: >-
                  API endpoint requires authentication. Please provide valid
                  X-App-Id and X-Api-Key headers.
            InvalidCredentials:
              value:
                error: Invalid credentials
                message: >-
                  The provided API credentials are invalid. Please check your
                  X-App-Id and X-Api-Key values.
  securitySchemes:
    AppIdAuth:
      type: apiKey
      in: header
      name: X-App-Id
      description: App ID for authentication
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API Key for authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.