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

# Quote payout

> Validates payout form input and returns quote details plus a payout intent ID.




## OpenAPI

````yaml /openapi/client-api.yaml post /clients/me/integrations/noah/payouts/quote
openapi: 3.1.0
info:
  title: Portal Client API
  version: '3.0'
  description: >
    The Portal Client API provides endpoints for managing wallets, building
    transactions,

    and interacting with blockchain networks. All endpoints require
    authentication via a

    Client API Key or Client Session Token (CST) passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Client API Key or Client Session Token as a Bearer token in the

    `Authorization` header of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Core client management endpoints
  - name: Wallet
    description: >-
      Read wallet state — balances, NFTs, transaction history, capabilities, and
      transaction details
  - name: Transactions
    description: Build, broadcast, and evaluate blockchain transactions
  - name: Funding
    description: Fund wallets with testnet tokens
  - name: Wallet Shares
    description: Manage signing and backup share pairs
  - name: Delegations
    description: Manage token approvals, revocations, and delegated transfers
  - name: Session Keys
    description: Manage EIP-7702 session keys for smart accounts
  - name: 0x
    description: Token swap endpoints powered by the 0x protocol
  - name: Yield.xyz
    description: Yield opportunities and staking actions powered by Yield.xyz
  - name: Li.Fi
    description: Cross-chain swaps and bridging powered by Li.Fi
  - name: Blockaid
    description: Transaction and address security scanning powered by Blockaid
  - name: Hypernative
    description: >-
      Transaction, address, token, and NFT security scanning powered by
      Hypernative
  - name: Noah
    description: KYC onboarding, payins, and payouts powered by Noah
  - name: Meld
    description: Buy and sell crypto with fiat through aggregated providers powered by Meld
  - name: EIP-7702
    description: EIP-7702 account type detection and authorization management
  - name: Deprecated
    description: >-
      Legacy endpoints scheduled for removal. Use the newer equivalents listed
      in each endpoint's description.
paths:
  /clients/me/integrations/noah/payouts/quote:
    post:
      tags:
        - Noah
      summary: Quote payout
      description: >
        Validates payout form input and returns quote details plus a payout
        intent ID.
      operationId: quoteNoahPayout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoahQuotePayoutRequest'
      responses:
        '200':
          description: Payout quote created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoahQuotePayoutResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    NoahQuotePayoutRequest:
      type: object
      required:
        - channelId
        - cryptoCurrency
      description: |
        Exactly one of `fiatAmount` or `cryptoAmount` must be provided. They are
        mutually exclusive — passing both (or neither) returns 400.
      oneOf:
        - required:
            - fiatAmount
        - required:
            - cryptoAmount
      properties:
        channelId:
          type: string
        cryptoCurrency:
          type: string
          description: >-
            Crypto currency symbol. In Noah sandbox, tickers must be suffixed
            with `_TEST` (e.g. `USDC_TEST`); use the unsuffixed ticker in
            production. See [Noah's sandbox naming
            convention](https://docs.noah.com/products/global-payouts-api/#sandbox-cryptocurrency-naming-convention).
        fiatAmount:
          type: string
          description: Fiat amount to receive. Mutually exclusive with `cryptoAmount`.
        cryptoAmount:
          type: string
          description: >-
            Exact crypto amount the depositor will send. Mutually exclusive with
            `fiatAmount`.
        quoted:
          type: boolean
          description: |
            When `true` and all form steps are complete, the response includes a
            `quote` whose `signedQuote` locks the conversion rate and recipient
            payout for the resulting payout transaction.
          default: false
        fiatCurrency:
          type: string
        form:
          type: object
          additionalProperties: true
        formSessionId:
          type: string
          format: uuid
          description: Optional form session ID continuing a multi-step form.
        paymentMethodId:
          type: string
        businessFee:
          $ref: '#/components/schemas/NoahBusinessFee'
    NoahQuotePayoutResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            payoutId:
              type: string
            formSessionId:
              type: string
            cryptoAmountEstimate:
              type: string
            cryptoAuthorizedAmount:
              type: string
              description: Maximum crypto amount that can be charged for this transaction.
            totalFee:
              type: string
            cryptoCurrency:
              type: string
              description: Crypto currency disclosure; locked when `quote` is present.
            fiatCurrency:
              type: string
              description: Fiat currency disclosure; locked when `quote` is present.
            fiatAmount:
              type: string
              description: >-
                Net fiat amount the recipient receives; locked when `quote` is
                present.
            rate:
              type: string
              description: Composite crypto→fiat rate; locked when `quote` is present.
            breakdown:
              type: array
              description: Per-type payment breakdown in `cryptoCurrency`.
              items:
                $ref: '#/components/schemas/NoahPayoutBreakdownItem'
            quote:
              description: |
                Fixed-rate quote. Present only when `quoted: true` was requested
                and all form steps are complete.
              nullable: true
              allOf:
                - $ref: '#/components/schemas/NoahPayoutQuote'
            nextStep:
              type: object
              nullable: true
              additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    NoahBusinessFee:
      type: object
      description: |
        Per-transaction business fee configuration. When supplied, this fee is
        applied to the customer's transaction on behalf of the business.
      properties:
        FeeBase:
          type: string
          description: Fixed base fee amount. When set, `FiatCurrency` is required.
        FeePct:
          type: string
          description: Variable percentage fee from 0 to 100 (e.g. `0.5` means 0.5%).
        FiatCurrency:
          type: string
    NoahPayoutBreakdownItem:
      type: object
      description: |
        Per-type payment breakdown item in `cryptoCurrency`. Items are additive:
        `ChannelFee + BusinessFee + Remaining = cryptoAmountEstimate`.
      required:
        - type
        - amount
      properties:
        type:
          type: string
          enum:
            - ChannelFee
            - BusinessFee
            - Remaining
        amount:
          type: string
    NoahPayoutQuote:
      type: object
      description: |
        Fixed-rate quote. Pass `signedQuote` back unchanged when creating the
        payout rule/transaction.
      required:
        - signedQuote
        - expiry
      properties:
        signedQuote:
          type: string
          description: Opaque bearer token encoding all binding claims for the quote.
        expiry:
          type: string
          format: date-time
          description: >-
            Deadline by which the deposit must be observed AND fully cleared for
            this quote to apply.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Client API Key or Client Session Token (CST). Pass as a Bearer token in
        the

        Authorization header.

````