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

# Initiate payout

> Initiates an onchain-deposit-to-payment-method workflow from a prepared payout intent.




## OpenAPI

````yaml /openapi/client-api.yaml post /clients/me/integrations/noah/payouts
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:
    post:
      tags:
        - Noah
      summary: Initiate payout
      description: >
        Initiates an onchain-deposit-to-payment-method workflow from a prepared
        payout intent.
      operationId: initiateNoahPayout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoahInitiatePayoutRequest'
      responses:
        '200':
          description: Payout initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoahInitiatePayoutResponse'
        '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:
    NoahInitiatePayoutRequest:
      type: object
      required:
        - payoutId
        - sourceAddress
        - expiry
        - nonce
        - network
      properties:
        payoutId:
          type: string
        sourceAddress:
          type: string
        expiry:
          type: string
          format: date-time
        nonce:
          type: string
          maxLength: 36
          description: >-
            Unique idempotency nonce for the payout request. Must not be reused
            across different transactions.
        network:
          type: string
          description: CAIP-2 chain ID.
        fiatAmount:
          type: string
          description: >-
            Fiat amount for the payout. Only applicable when trigger.Type is
            SingleOnchainDepositSourceTriggerInput.
        trigger:
          $ref: '#/components/schemas/NoahTriggerInput'
        businessFee:
          $ref: '#/components/schemas/NoahBusinessFee'
    NoahInitiatePayoutResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            destinationAddress:
              type: string
              nullable: true
            conditions:
              type: array
              items:
                type: object
                properties:
                  amountConditions:
                    type: array
                    items:
                      type: object
                      properties:
                        comparisonOperator:
                          type: string
                        value:
                          type: string
                  cryptoCurrency:
                    type: string
                  network:
                    type: string
                  destinationAddress:
                    oneOf:
                      - type: string
                      - type: object
                        properties:
                          address:
                            type: string
                additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    NoahTriggerInput:
      type: object
      description: |
        Defines when and how the automated sell rule fires. Three variants
        discriminated by `Type` (each with slightly different shape):

        - `SingleOnchainDepositSourceTriggerInput` — executes once.
          `Conditions[*]` must include `AmountConditions`. The persisted
          `fiatAmount` from the quote is forwarded.
        - `PermanentOnchainDepositSourceTriggerInput` — fires on every matching
          deposit; the entire deposited crypto amount is always sold.
          `Conditions[*]` carries `Network` only — `AmountConditions` must be
          omitted. Optional `NetworkAgnostic` flag matches any network.
        - `QuotedOnchainDepositSourceTriggerInput` — executes once and locks
          the conversion rate from a prior `SellQuote`. Requires `SignedQuote`
          (from `quote.signedQuote` on `POST /payouts/quote`). `Conditions[*]`
          carries `Network` only — `AmountConditions` must be omitted. `Expiry`
          is optional and defaults to the bound quote's expiry.
      required:
        - Type
        - Conditions
        - SourceAddress
        - Nonce
      properties:
        Type:
          type: string
          enum:
            - SingleOnchainDepositSourceTriggerInput
            - PermanentOnchainDepositSourceTriggerInput
            - QuotedOnchainDepositSourceTriggerInput
        Conditions:
          type: array
          items:
            $ref: '#/components/schemas/NoahTriggerConditionInput'
        SourceAddress:
          type: string
        Expiry:
          type: string
          format: date-time
          description: >-
            Required on Single/Permanent. Optional on Quoted (defaults to the
            bound quote's Expiry).
        Nonce:
          type: string
        SignedQuote:
          type: string
          description: |
            Required when `Type` is `QuotedOnchainDepositSourceTriggerInput`.
            Opaque bearer returned in `quote.signedQuote` from
            `POST /payouts/quote` when `quoted: true` was requested. Pass back
            unchanged — Noah verifies the signature and rejects tampered or
            expired quotes.
        NetworkAgnostic:
          type: boolean
          default: false
          description: >
            Optional. Only valid for
            `PermanentOnchainDepositSourceTriggerInput`.

            When `true`, match deposits to the destination address from any
            network.
    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
    NoahTriggerConditionInput:
      type: object
      required:
        - Network
      properties:
        AmountConditions:
          type: array
          description: |
            Required for `SingleOnchainDepositSourceTriggerInput`. Must be
            omitted for `PermanentOnchainDepositSourceTriggerInput` and
            `QuotedOnchainDepositSourceTriggerInput` (amount/currency are
            derived server-side from the bound quote / matched on the full
            deposit).
          items:
            $ref: '#/components/schemas/NoahAmountCondition'
        Network:
          type: string
    NoahAmountCondition:
      type: object
      required:
        - ComparisonOperator
        - Value
      properties:
        ComparisonOperator:
          type: string
          enum:
            - EQ
            - LTEQ
            - GTEQ
          description: |
            Comparison operator for the field value:
            - `EQ` (Equals)
            - `LTEQ` (Less Than Or Equals)
            - `GTEQ` (Greater Than Or Equals)
        Value:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Client API Key or Client Session Token (CST). Pass as a Bearer token in
        the

        Authorization header.

````