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

# Payout Fee

> Estimate transfer fee before creating a payout.



## OpenAPI

````yaml /openapi.yaml post /payouts/fee
openapi: 3.1.0
info:
  title: Keette API
  version: 1.0.0
  description: |
    Public HTTP API for Keette workspaces. One base URL — live vs sandbox is
    selected by your API key (`sk_live_…` / `sk_test_…`).

    Endpoints are added as each implementation phase ships.
  contact:
    name: Keette Support
    email: talk@keette.com
servers:
  - url: https://20b9-41-90-209-232.ngrok-free.app/v1
    description: Local (ngrok)
  - url: https://api.keette.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Identity for the authenticating API key
  - name: Balances
    description: Wallet books
  - name: Beneficiaries
    description: Payout recipients
  - name: Transactions
    description: Unified transaction index
  - name: FX
    description: Indicative rates and firm quotes
  - name: Catalog
    description: Payout corridors and relationships
  - name: Payouts
    description: Send money to a beneficiary
  - name: Payins
    description: Collect money into your books
  - name: Swaps
    description: FX between your own books
  - name: Events
    description: Durable event log for webhook polling
paths:
  /payouts/fee:
    post:
      tags:
        - Payouts
      summary: Payout Fee
      description: Estimate transfer fee before creating a payout.
      operationId: payoutFee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutFeeRequest'
            examples:
              estimate:
                summary: Fee for a NGN send
                value:
                  beneficiary_id: bbd938a2-dbbe-43bf-bfb9-1c5dbe444523
                  currency: NGN
                  amount: 5000000
      responses:
        '200':
          description: Fee quote
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutFee'
              examples:
                fee:
                  value:
                    object: payout_fee
                    currency: NGN
                    amount: 5000000
                    transfer_fee: 10000
                    total: 5000000
                    exact: false
                    scale: 2
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PayoutFeeRequest:
      type: object
      required:
        - beneficiary_id
        - currency
        - amount
      properties:
        beneficiary_id:
          type: string
          format: uuid
          description: Beneficiary the fee estimate applies to.
          example: bbd938a2-dbbe-43bf-bfb9-1c5dbe444523
        currency:
          type: string
          description: Source book currency for the planned send.
          example: NGN
        amount:
          type: integer
          description: Planned send amount in Ledger minor units.
          example: 5000000
        quote_id:
          type: string
          format: uuid
          description: Optional firm quote id for cross-currency fee accuracy.
        recipient_amount:
          type: integer
          description: >
            Optional estimated recipient amount in their currency minor units
            when

            you do not yet have a firm `quote_id`.
    PayoutFee:
      type: object
      properties:
        object:
          type: string
          enum:
            - payout_fee
          description: Object type discriminator.
        currency:
          type: string
          description: Currency of `amount`, `transfer_fee`, and `total`.
        amount:
          type: integer
          description: Requested send amount in Ledger minor units.
        transfer_fee:
          type: integer
          description: Estimated customer-visible transfer fee in minor units.
        total:
          type: integer
          description: Amount plus fee (what leaves the book), in minor units.
        exact:
          type: boolean
          description: |
            `true` when the fee is final for this input; `false` when indicative
            (e.g. before a firm FX quote).
        min_payment:
          type: integer
          description: Minimum allowed send for this corridor, if applicable.
        scale:
          type: integer
          description: Decimal places for the currency (usually 2).
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              description: Broad error class for client handling.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - rate_limit
                - api_error
            code:
              type: string
              description: Stable machine-readable code (e.g. `parameter_invalid`).
            message:
              type: string
              description: Human-readable explanation safe to show developers.
            param:
              type: string
              description: Request field that failed validation, when applicable.
            doc_url:
              type: string
              format: uri
              description: Optional link to docs for this error.
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: invalid_api_key
              message: Invalid API key provided.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: |
        Secret API key from **Settings → Developers → API keys**.
        Example: `Authorization: Bearer sk_test_…`

````

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