> ## 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.

# List payment methods

> Find the available payment methods, fees and amount limits for a currency.

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

Use type=withdraw for payouts and type=deposit for receiving options. For a payout, provide amount in the destination currency to show methods that cover it. Use the returned deliveryOptions to choose a method and pass its values unchanged in the quote. External payout options include amountBands; minimumAmount and maximumAmount are their outer bounds, so keep gaps between bands unsupported. Limits apply to the selected method or network, not to every payment in that currency. GET /v1/payouts/catalogue lists fee bands separately. Missing options or limits do not mean unlimited payments. Discovery does not approve a payment. HTTP 423 COMPLIANCE\_REVIEW\_REQUIRED means the destination needs review; do not retry automatically or create a replacement recipient. HTTP 404 means the requested recipient was not found.


## OpenAPI

````yaml /openapi/public.yaml get /v1/quotes/payment-options
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/quotes/payment-options:
    get:
      tags:
        - Payment options
      summary: List payment methods
      description: >-
        Find the available payment methods, fees and amount limits for a
        currency.
      operationId: listQuotePaymentOptions
      parameters:
        - in: query
          name: type
          required: true
          schema:
            type: string
            enum:
              - deposit
              - withdraw
          example: withdraw
        - in: query
          name: currency
          required: true
          schema:
            type: string
            minLength: 1
          example: USD
        - in: query
          name: amount
          required: false
          schema:
            type: string
            pattern: ^(?=.*[1-9])(0|[1-9]\d*)(?:\.\d+)?$
          example: '100.00'
        - in: query
          name: chain
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 100
          description: The crypto network to use when checking your business's payout fees.
          example: ETHEREUM_SEPOLIA
        - in: query
          name: recipientId
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 200
          description: >-
            A recipient saved by your business. Use it to filter payout options;
            it is not accepted for deposit options.
          example: recipient_example_001
        - in: query
          name: businessId
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 200
          description: >-
            The Ledig business you want to pay. Use with type=withdraw, omit
            chain and do not also supply recipientId.
          example: business_example_001
        - in: query
          name: paymentMethodId
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 200
          description: >-
            The payout method whose availability you want explained. Creating a
            quote and sending the payment check availability again.
          example: method_example_001
      responses:
        '200':
          description: Eligible deposit or withdrawal payment options.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    required:
                      - data
                    properties:
                      availability:
                        $ref: '#/components/schemas/PayoutSelectionAvailability'
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/PaymentOption'
              example:
                status: success
                data:
                  - channel: bank
                    name: Bank transfer
                    description: Send USD to a bank account.
                    currency: USD
                    paymentMethodIds:
                      - method_example_001
                    minimumFee: '2.00'
                    maximumFee: '2.00'
                    minimumAmount: '10.00'
                    maximumAmount: '10000.00'
                    amountBands:
                      - minimumAmount: '10.00'
                        maximumAmount: '10000.00'
                    supportConversion: true
                    invoiceRequired: false
                    deliveryOptions:
                      - paymentMethodId: method_example_001
                        channel: bank_transfer
                        label: Bank transfer
                        recipientTypes:
                          - bank
                    feeQuotes:
                      - paymentMethodId: method_example_001
                        feeAmount: '2.00'
                        feeCurrency: USD
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '423':
          description: >-
            COMPLIANCE_REVIEW_REQUIRED: this payment needs review before it can
            proceed. Check its status or contact support@ledig.io.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: error
                code: COMPLIANCE_REVIEW_REQUIRED
                message: This action requires a review before it can continue.
        '429':
          $ref: '#/components/responses/RateLimited'
      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 = "GET";

            const path = `/v1/quotes/payment-options`;

            const query = new URLSearchParams({
              "type": "withdraw",
              "currency": "USD"
            }).toString();

            const pathWithQuery = `${path}?${query}`;

            const rawBody = "";

            const headers = { "Accept": "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,
            });

            const result = await response.json();

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

            console.log(response.status);
components:
  schemas:
    Success:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: success
        message:
          type: string
    PayoutSelectionAvailability:
      type: object
      additionalProperties: false
      required:
        - paymentMethodId
        - currency
        - available
      properties:
        paymentMethodId:
          type: string
          minLength: 1
          maxLength: 200
        currency:
          type: string
        chain:
          type: string
          minLength: 1
          maxLength: 100
        available:
          type: boolean
        reason:
          type: string
          enum:
            - payout_amount_out_of_range
            - payout_amount_unavailable
            - recipient_incompatible
            - network_unavailable
            - payout_unavailable
          description: >-
            A reason explaining why the selected payment method is available or
            unavailable.
        requested:
          type: string
        minimumAmount:
          type: string
        maximumAmount:
          type:
            - string
            - 'null'
        amountBands:
          type: array
          description: >-
            Supported payout amount bands when the requested amount is outside
            the limits or falls in a gap. Other availability reasons may omit
            this field.
          items:
            $ref: '#/components/schemas/PayoutAmountBand'
      description: >-
        Availability of the selected payout method. Amount limits use the
        destination currency; conversion limits are separate. Availability is
        checked again when you send.
    PaymentOption:
      type: object
      additionalProperties: false
      required:
        - channel
        - name
        - description
        - currency
        - paymentMethodIds
        - minimumFee
        - maximumFee
        - minimumAmount
        - maximumAmount
        - supportConversion
        - invoiceRequired
      properties:
        channel:
          type: string
        name:
          type: string
        description:
          type: string
        currency:
          type: string
        paymentMethodIds:
          type: array
          items:
            type: string
        minimumFee:
          type: string
        maximumFee:
          type: string
        minimumAmount:
          type: string
        maximumAmount:
          type:
            - string
            - 'null'
          description: >-
            The outer maximum payout amount. For external payouts, check
            amountBands because intermediate gaps remain unsupported. Null means
            no maximum.
        amountBands:
          type: array
          description: >-
            Supported amount ranges for external payouts in the destination
            currency. Keep gaps between ranges unsupported. Omitted for deposit
            and Ledig network options.
          items:
            $ref: '#/components/schemas/PayoutAmountBand'
        supportConversion:
          type: boolean
        executionMode:
          type: string
          enum:
            - provider
            - ledig
          description: >-
            How the payout will be sent. For a recipient entered with manual
            bank details, choose an eligible option returned for that recipient
            with executionMode=ledig. This requirement is checked again when you
            send.
        invoiceRequired:
          type: boolean
          default: false
          description: >-
            Whether every method in this option requires an invoice. This does
            not make transferPurpose required.
        feeQuoteRequired:
          type: boolean
          description: >-
            True when a fee cannot yet be shown for this option. Create a quote
            to confirm the fee before sending.
        deliveryOptions:
          type: array
          description: >-
            Use these choices when building your payment selection. Empty means
            no suitable single payment choice is available. Existing names and
            paymentMethodIds remain accepted. Recipient types identify type
            categories, not requirement IDs.
          items:
            type: object
            additionalProperties: false
            required:
              - paymentMethodId
              - channel
              - label
              - recipientTypes
            properties:
              paymentMethodId:
                type: string
              channel:
                type: string
              label:
                type: string
                description: >-
                  A label for your payment screen. The ledig choice is shown as
                  Send via the Ledig network. Changing the label does not change
                  its ID.
              description:
                type: string
                maxLength: 160
                description: >-
                  Optional help text for a payment choice, such as Send to
                  another Ledig business using its business ID.
              chain:
                type: string
                description: >-
                  Send this exact value when creating a quote. Use feeChain
                  separately to match fee rows.
              canonicalNetwork:
                type: string
                description: >-
                  The network ID to match against the recipient's
                  destinationScope.network. Main networks and test networks have
                  different IDs.
              networkName:
                type: string
              recipientTypes:
                type: array
                items:
                  type: string
              feeChain:
                type: string
                description: >-
                  The network value used to match fee rows. It may differ from
                  chain; do not send it in place of chain when creating a quote.
              testnet:
                type: boolean
        feeQuotes:
          type: array
          description: >-
            Estimated fees for this business and payment method. Create a quote
            to confirm the final terms.
          items:
            type: object
            additionalProperties: false
            required:
              - paymentMethodId
              - feeAmount
              - feeCurrency
            properties:
              paymentMethodId:
                type: string
              feeAmount:
                type: string
              feeCurrency:
                type: string
              chain:
                type: string
    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.
    PayoutAmountBand:
      type: object
      additionalProperties: false
      required:
        - minimumAmount
        - maximumAmount
      properties:
        minimumAmount:
          type: string
        maximumAmount:
          type:
            - string
            - 'null'
  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.
    NotFound:
      description: The requested resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: NOT_FOUND
            message: The requested resource was not found.
    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.
  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.

````

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