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

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# Payout available balances

> Payout all available balances of your account to the preconfigured beneficiary bank account or wallet. If you want to handle payouts in a more dynamic and granular way, please use the POST /payout/create endpoint.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/beneficiary-payout/create
openapi: 3.0.0
info:
  title: Ivy API
  description: Ivy API schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers:
  - url: https://api.getivy.de
    description: Production
  - url: https://api.sand.getivy.de
    description: Sandbox
security: []
tags: []
paths:
  /api/service/beneficiary-payout/create:
    post:
      tags:
        - Payout
        - Beneficiary Payout
      summary: Payout available balances
      description: >-
        Payout all available balances of your account to the preconfigured
        beneficiary bank account or wallet. If you want to handle payouts in a
        more dynamic and granular way, please use the POST /payout/create
        endpoint.
      operationId: BeneficiaryPayoutController_perform
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            Idempotency key for safe retries. Reusing the same key always
            returns the cached response.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Succeeded Beneficiary Payouts of available balances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformPayoutResponseDto'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Ivy from '@getivy/node-sdk';

            const client = new Ivy({
              apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
            });

            const beneficiaryPayouts = await client.beneficiaryPayouts.create();

            console.log(beneficiaryPayouts);
components:
  schemas:
    PerformPayoutResponseDto:
      description: Array of Beneficiary Payouts
      type: array
      items:
        type: object
        properties:
          id:
            description: The unique identifier of the beneficiary payout
            type: string
          type:
            description: The type of payout
            type: string
            enum:
              - merchant
              - customer
          referenceId:
            description: The reference identifier for the payout
            type: string
          merchant:
            description: The merchant identifier
            type: string
          amount:
            description: The beneficiary payout amount
            type: number
          description:
            description: Description of the payout
            type: string
          statementDescriptor:
            description: The descriptor that appears on bank statements
            type: string
          status:
            description: The current status of the payout
            type: string
            enum:
              - paid
              - pending
              - in_transit
              - failed
              - canceled
            x-enumNames:
              - Paid
              - Pending
              - InTransit
              - Failed
              - Canceled
          currency:
            description: >-
              The currency of the balance which was settled to the beneficiary
              bank account or wallet.
            type: string
            enum:
              - EUR
              - USD
              - GBP
              - PLN
              - SEK
              - DKK
            x-enumNames:
              - EUR
              - USD
              - GBP
              - PLN
              - SEK
              - DKK
          createdAt:
            description: The creation timestamp of the payout
        required:
          - id
          - type
          - referenceId
          - merchant
          - amount
          - description
          - statementDescriptor
          - status
          - currency
          - createdAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Ivy-Api-Key
      description: API key for authentication

````