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

# Estimate a payout fee

> Check the fee for an amount and payment method before creating a quote.

**Required scope:** `quotes:read`

Read Only API keys can call this endpoint even though it uses POST. Custom keys need quotes:read, and your business needs access to quotes. This does not give the key access to other POST endpoints. Send a positive decimal amount with the currency's supported precision. For crypto, send the exact network ID; omit network for bank or mobile money payouts. If more than one fee band matches, send a bandId from GET /v1/payouts/catalogue. An unknown bandId is rejected. Selecting a band can return its fee even when the amount is outside its limits; check amountWithinLimits and payout availability. Use the returned feeAmount instead of calculating the fee yourself. Missing or ambiguous pricing is not a zero fee. This request creates no quote or payment. Create a fresh quote before sending. Responses use Cache-Control: private, no-store.


## OpenAPI

````yaml /openapi/public.yaml post /v1/payouts/fee-estimate
openapi: 3.1.0
info:
  title: Ledig payments API
  version: 0.1.0
  description: >-
    Use the Ledig payments engine to receive funds, view balances, convert
    currencies and send payments.


    Choose Sandbox to test your integration or Live for production payments.
    Each endpoint explains the fields, permissions and errors you need to
    handle.


    Sign API requests with your business API key and HMAC-SHA256. Endpoints
    listing BearerAuth also accept a user access token. Follow
    https://docs.ledig.io/auth/authentication to sign your requests.
  contact:
    name: Ledig
    email: support@ledig.io
    url: https://docs.ledig.io
servers:
  - url: https://api-sandbox.ledig.io
    description: Sandbox
  - url: https://api.ledig.io
    description: Live
security:
  - LedigApiKey: []
    LedigTimestamp: []
    LedigSignature: []
tags:
  - name: Managed businesses
    description: Onboarding for businesses you manage.
  - name: System
    description: Health and availability.
  - name: Balances
    description: Your available and reserved funds by currency.
  - name: Currencies and rates
    description: Supported currencies, networks and indicative rates.
  - name: Funding accounts
    description: Fiat accounts that receive customer deposits.
  - name: Deposit wallets
    description: Crypto addresses that receive customer deposits.
  - name: Recipients
    description: Saved payout destinations.
  - name: Ledig businesses
    description: Find a business before paying through the Ledig network.
  - name: Payment options
    description: Available payout methods, fees and limits.
  - name: Quotes
    description: Confirm rates, fees and amounts before sending.
  - name: Transfers
    description: Start and track conversions and payments.
  - name: Transactions
    description: Customer transaction history.
paths:
  /v1/payouts/fee-estimate:
    post:
      tags:
        - Payment options
      summary: Estimate a payout fee
      description: Check the fee for an amount and payment method before creating a quote.
      operationId: estimatePayoutCustomerFee
      parameters:
        - $ref: '#/components/parameters/SelectedBusinessId'
        - $ref: '#/components/parameters/ActingBusinessId'
        - $ref: '#/components/parameters/SelectedProfileId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutFeeEstimateRequest'
            example:
              currency: USD
              payoutType: fiat
              amount: '100.00'
      responses:
        '200':
          description: >-
            The estimated fee, or an explanation that pricing is unavailable.
            Payout availability is shown separately.
          headers:
            Cache-Control:
              schema:
                type: string
                const: private, no-store
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        $ref: '#/components/schemas/PayoutCustomerFeeEstimate'
              example:
                status: success
                data:
                  pricedAt: '2026-01-15T10:00:00.000Z'
                  currency: USD
                  payoutType: fiat
                  amount: '100.00'
                  bandId: pbd_11111111111111111111111111111111
                  minimumAmount: '10.00'
                  maximumAmount: '10000.00'
                  amountWithinLimits: true
                  pricing:
                    status: available
                    feeCurrency: USD
                    terms:
                      fixedFee: '2.00'
                      feeBps: 0
                      minimumFee: null
                      maximumFee: null
                    effectiveFrom: '2026-01-15T10:00:00.000Z'
                    validUntil: null
                    feeAmount: '2.00'
                  payoutAvailability:
                    status: available
                    reasonCode: ready_for_quote
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - BearerAuth: []
        - LedigApiKey: []
          LedigTimestamp: []
          LedigSignature: []
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: >-
            import { createHmac } from "node:crypto";


            // Node.js 18+. Set credentials and resource values on your server.

            function required(name) {
              const value = process.env[name];
              if (!value) throw new Error(`Set ${name} before running this example.`);
              return value;
            }


            const baseUrl = process.env.LEDIG_API_BASE_URL ??
            "https://api-sandbox.ledig.io";

            const method = "POST";

            const path = `/v1/payouts/fee-estimate`;

            const pathWithQuery = path;

            const body = {
              "currency": "USD",
              "payoutType": "fiat",
              "amount": "100.00"
            };

            const rawBody = JSON.stringify(body);

            const headers = { "Accept": "application/json" };

            headers["Content-Type"] = "application/json";

            const timestamp = Math.floor(Date.now() / 1000).toString();

            const payload =
            `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;

            headers["x-ledig-key"] = required("LEDIG_API_KEY");

            headers["x-ledig-timestamp"] = timestamp;

            headers["x-ledig-signature"] = "v1=" + createHmac("sha256",
            required("LEDIG_API_SECRET"))
              .update(payload).digest("base64");

            const response = await fetch(`${baseUrl}${pathWithQuery}`, {
              method,
              headers,
              body: rawBody,
            });

            const result = await response.json();

            // Use result in your application; do not log credentials or upload
            links.

            console.log(response.status);
components:
  parameters:
    SelectedBusinessId:
      in: header
      name: X-Ledig-Business-Id
      required: false
      description: >-
        The business you are acting for. For a managed business, your
        institution must be authorised to act for it and API-key requests must
        use HMAC v2. Set this header explicitly; a business ID in the body does
        not select the business.
      schema:
        type: string
        minLength: 1
      example: institution_example_001
    ActingBusinessId:
      in: header
      name: X-Ledig-Acting-Business-Id
      required: false
      description: >-
        Your institution's business ID when acting for a managed business. It
        must match your API key's owner or an institution you belong to. HMAC v2
        signs the trimmed value, or an empty string when omitted.
      schema:
        type: string
        minLength: 1
      example: institution_example_001
    SelectedProfileId:
      in: header
      name: X-Ledig-Profile-Id
      required: false
      description: >-
        An optional business selection header supported by existing
        integrations. For a managed business, omit it or use the same value as
        X-Ledig-Business-Id. HMAC v2 includes it in the signed request.
      schema:
        type: string
        minLength: 1
      example: institution_example_001
  schemas:
    PayoutFeeEstimateRequest:
      type: object
      additionalProperties: false
      required:
        - currency
        - payoutType
        - amount
      properties:
        currency:
          type: string
          pattern: ^[A-Za-z][A-Za-z0-9]{1,11}$
        payoutType:
          type: string
          enum:
            - fiat
            - crypto
        amount:
          type: string
          pattern: ^(?:0|[1-9]\d{0,18})(?:\.\d{1,18})?$
          description: >-
            A positive amount using no more than the selected currency's
            supported decimal places.
        network:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            The exact network ID for a crypto payout. Omit for bank or mobile
            money payouts.
        bandId:
          type: string
          pattern: ^pbd_[a-f0-9]{32}$
    Success:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: success
        message:
          type: string
    PayoutCustomerFeeEstimate:
      type: object
      additionalProperties: false
      required:
        - pricedAt
        - currency
        - payoutType
        - amount
        - amountWithinLimits
        - pricing
        - payoutAvailability
      properties:
        pricedAt:
          type: string
          format: date-time
        currency:
          type: string
        payoutType:
          type: string
          enum:
            - fiat
            - crypto
        canonicalNetwork:
          type: string
        amount:
          type: string
        bandId:
          type: string
          pattern: ^pbd_[a-f0-9]{32}$
        minimumAmount:
          type: string
        maximumAmount:
          type:
            - string
            - 'null'
          description: >-
            The maximum payout amount. Null means this crypto option has no
            maximum and its minimum must be zero. Bank and mobile money options
            have a maximum.
        amountWithinLimits:
          type: boolean
        pricing:
          oneOf:
            - $ref: '#/components/schemas/PayoutCustomerFeeEstimateAvailable'
            - $ref: '#/components/schemas/PayoutCustomerFeeUnavailable'
        payoutAvailability:
          $ref: '#/components/schemas/PayoutCatalogueAvailability'
    PayoutCustomerFeeEstimateAvailable:
      type: object
      additionalProperties: false
      required:
        - status
        - feeCurrency
        - terms
        - effectiveFrom
        - validUntil
        - feeAmount
      properties:
        status:
          type: string
          const: available
        feeCurrency:
          type: string
        terms:
          $ref: '#/components/schemas/PayoutCustomerFeeTerms'
        effectiveFrom:
          type: string
          format: date-time
        validUntil:
          type:
            - string
            - 'null'
          format: date-time
        feeAmount:
          type: string
          description: >-
            The calculated payout fee for this estimate. A value of zero is a
            valid fee.
    PayoutCustomerFeeUnavailable:
      type: object
      additionalProperties: false
      required:
        - status
        - reasonCode
      properties:
        status:
          type: string
          const: unavailable
        reasonCode:
          type: string
          enum:
            - pricing_unavailable
            - ambiguous_scope
            - scope_unavailable
    PayoutCatalogueAvailability:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - status
            - reasonCode
          properties:
            status:
              type: string
              const: available
            reasonCode:
              type: string
              const: ready_for_quote
        - type: object
          additionalProperties: false
          required:
            - status
            - reasonCode
          properties:
            status:
              type: string
              const: unknown
            reasonCode:
              type: string
              const: availability_unverified
        - type: object
          additionalProperties: false
          required:
            - status
            - reasonCode
          properties:
            status:
              type: string
              const: unavailable
            reasonCode:
              type: string
              enum:
                - payouts_paused
                - amount_outside_limits
                - routing_conflict
                - payout_restricted
                - not_configured
    Error:
      type: object
      required:
        - status
        - message
        - code
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        code:
          type: string
        details:
          description: >-
            Additional information to help resolve an error, such as a file
            problem, allowed amount range or remaining payment allowance. The
            fields depend on the error code.
          oneOf:
            - type: object
              additionalProperties: false
              description: >-
                File-validation details returned with HTTP 400, 413 or 422
                BAD_REQUEST.
              required:
                - validationCode
                - reasonCode
                - retryable
              properties:
                validationCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                reasonCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                retryable:
                  type: boolean
                  const: false
                documentId:
                  type: string
                  maxLength: 128
                requirementType:
                  type: string
                maxSizeBytes:
                  type: integer
                  minimum: 1
                  maximum: 1073741824
                  description: >-
                    Maximum accepted file size in bytes, when supplied with HTTP
                    413.
            - type: object
              additionalProperties: false
              required:
                - reason
              properties:
                reason:
                  type: string
                  enum:
                    - current_password_incorrect
                    - unsupported_asset_network
                    - recipient_unavailable
                    - recipient_incompatible
                    - payout_method_unavailable
                    - payout_method_incompatible
                    - network_unavailable
                    - quote_expired
                    - quote_already_used
                    - quote_changed
                    - invoice_required
                    - invoice_invalid
                    - amount_invalid
                    - amount_precision_invalid
                    - onboarding_revision_required
                    - onboarding_revision_changed
                    - onboarding_document_kind_mismatch
                precision:
                  type: integer
                  minimum: 0
                  maximum: 18
                  description: >-
                    Allowed number of decimal places when reason is
                    amount_precision_invalid.
            - type: object
              additionalProperties: false
              required:
                - period
                - sourceCurrency
                - requested
                - remaining
                - limit
                - resetsAt
                - timezone
              properties:
                period:
                  type: string
                  enum:
                    - daily
                    - monthly
                sourceCurrency:
                  type: string
                  pattern: ^[A-Z][A-Z0-9]{1,19}$
                requested:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                remaining:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                limit:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
            - type: object
              additionalProperties: false
              required:
                - sourceCurrency
                - minimumAmount
                - maximumAmount
              properties:
                sourceCurrency:
                  type: string
                minimumAmount:
                  type: string
                maximumAmount:
                  type: string
              description: >-
                Returned with HTTP 422 RATE_ROUTE_AMOUNT_OUT_OF_RANGE. These
                limits apply to the amount being converted, in the source
                currency.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - limitUsd
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                limitUsd:
                  type: string
              description: >-
                Returned with HTTP 422 PAYOUT_TRANSACTION_LIMIT_EXCEEDED. This
                per-payment limit uses USD equivalent and is separate from the
                payout method's currency limits.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - remainingUsd
                - resetsAt
                - timezone
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                remainingUsd:
                  type: string
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
              description: >-
                Returned with HTTP 422 PAYOUT_MONTHLY_LIMIT_EXCEEDED. Shows your
                business's remaining monthly allowance and when it resets.
    PayoutCustomerFeeTerms:
      type: object
      additionalProperties: false
      required:
        - fixedFee
        - feeBps
        - minimumFee
        - maximumFee
      description: >-
        Your current fee terms. The fee combines fixed and amount-based charges,
        applies the minimum and maximum, applies your business adjustment once,
        reapplies the limits and rounds once. Use the fee estimate endpoint for
        the final amount rather than calculating it yourself.
      properties:
        fixedFee:
          type: string
        feeBps:
          type: integer
          minimum: 0
          maximum: 10000
        minimumFee:
          type:
            - string
            - 'null'
        maximumFee:
          type:
            - string
            - 'null'
        adjustment:
          type: object
          additionalProperties: false
          required:
            - type
            - unit
            - value
          properties:
            type:
              type: string
              enum:
                - markup
                - markdown
            unit:
              type: string
              enum:
                - percentage
                - fixed
            value:
              type: string
  responses:
    BadRequest:
      description: The request is invalid. Check the error message and submitted fields.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: BAD_REQUEST
            message: Check the request fields and try again.
    Unauthorized:
      description: >-
        Authentication is missing, invalid or expired. Check your credentials
        and request signature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: UNAUTHORIZED
            message: Authentication is required.
    Forbidden:
      description: >-
        Your account is inactive, the business selection is missing, or your
        credentials do not have the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: FORBIDDEN
            message: You do not have permission to perform this action.
    RateLimited:
      description: >-
        A request or operation allowance has been reached. Wait before retrying.
        If the endpoint uses an idempotency key, keep the same key for the
        retry.
      headers:
        Retry-After:
          description: The number of seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
        Cache-Control:
          description: >-
            Responses use private, no-store or no-store. Do not cache this
            response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: RATE_LIMITED
            message: Too many requests. Wait before trying again.
    ServiceUnavailable:
      description: >-
        The requested service is temporarily unavailable. Follow the retry
        guidance for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: PROVIDER_UNAVAILABLE
            message: This service is temporarily unavailable. Please try again later.
  securitySchemes:
    LedigApiKey:
      type: apiKey
      in: header
      name: x-ledig-key
      description: >-
        Your business API key ID. Keep its secret on your server and use that
        secret to sign each request.
    LedigTimestamp:
      type: apiKey
      in: header
      name: x-ledig-timestamp
      description: The current Unix timestamp in seconds, used in the signed request.
    LedigSignature:
      type: apiKey
      in: header
      name: x-ledig-signature
      description: >-
        The request's HMAC-SHA256 signature. Use the v1= prefix for supported
        own-business requests, or v2= when acting for a managed business with
        signed business-selection headers. Follow the authentication guide to
        construct and sign the exact request.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A user access token from sign-in. Send Authorization: Bearer followed by
        the token. Use this only on endpoints that list BearerAuth.

````

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