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

# Create a payout route

> Connect an allow-listed bank account to a crypto deposit asset for pay-outs.

**Requires scope:** `manage:pay-outs` — see [Required scopes](/getting-started/authentication#required-scopes-finance-api).

Creates an account-scoped route connecting an allow-listed [payout bank account](/api-reference/Finance-API/payout-bank-accounts/register-a-payout-bank-account) to a crypto deposit asset. The route fixes the beneficiary, lane, asset and fiat currency for every pay-out made over it.

The provider is resolved internally from your tenant's enablement — the request never names one, and provider identity is never exposed.

<Note>
  **The recipient gate must pass.** The bank account's party needs an `ACTIVE` `PAYOUT_RECIPIENT` role on this account with cleared KYC/KYB. Add it via [Add a party to an account](/api-reference/Finance-API/accounts/add-a-party-to-an-account). A party may hold `PAYOUT_RECIPIENT` alongside `ACCOUNT_HOLDER` on the same account — that is the self-payout case.
</Note>

Routes are created `PENDING` and progress `REGISTERING → ACTIVE` as provider registration completes, or `REJECTED` on terminal failure. **Only `ACTIVE` routes are usable**, so poll [List payout routes](/api-reference/Finance-API/payout-routes/list-payout-routes) before requesting a pay-out.

See [Pay-outs](/guides/finance/payouts) for the full flow.

## Errors

The codes this endpoint can return, in addition to the [standard errors](/guides/finance/errors#standard-errors). Branch on `code`, never the message.

| HTTP  | `code`                     | When                                                                                                   |
| ----- | -------------------------- | ------------------------------------------------------------------------------------------------------ |
| `422` | `recipient-not-authorized` | the bank account's party has no `PAYOUT_RECIPIENT` role on this account, or its KYC/KYB is not cleared |
| `422` | `recipient-role-inactive`  | the `PAYOUT_RECIPIENT` role exists but is `INACTIVE`                                                   |
| `422` | `unsupported-asset`        | the deposit asset is not supported for your company                                                    |
| `422` | `unsupported-combination`  | no single provider resolves for this bank account and deposit asset                                    |


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes
openapi: 3.1.0
info:
  title: Venly Finance API
  description: >
    REST API for the Venly Finance platform:

    - Party management (Individuals & Organisations)

    - Identity verification — hosted KYC/KYB links and Sumsub share-token
    forwarding

    - Account management with party association

    - Wallet balances & token allowances on supported chains

    - Virtual bank accounts for global pay-in (EUR SEPA, USD ACH/WIRE/RTP/SWIFT)

    - Fiat-to-crypto payment sessions (pay-in)

    - Bank pay-outs — beneficiary allow-listing, routes, and PULL/PUSH pay-outs

    - Account-to-account fiat & crypto transfers

    - EIP-2612 permits and allowances

    - Webhook registration for asynchronous event delivery


    ## Authentication


    All endpoints use OAuth2 client credentials. Obtain a token first, then
    include it in every request:


    **Step 1 — Get a token:**

    ```bash

    curl -X POST
    https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
    \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "grant_type=client_credentials&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}"
    ```


    **Step 2 — Use the token:**

    ```

    Authorization: Bearer {access_token}

    ```


    Tokens expire after **5 minutes**. Implement refresh logic in your client.
  version: 1.5.0
  contact:
    name: Venly Support
    email: support@venly.io
    url: https://docs.venlyfinance.com
  license:
    name: Proprietary
  x-logo:
    url: https://venlyfinance.com/logo.png
  x-security-contact: security@venly.io
servers:
  - url: https://api.venlyfinance.com/v1
    description: Production
  - url: https://api-staging.venlyfinance.com/v1
    description: Staging
security:
  - OAuth2: []
tags:
  - name: Parties
    description: Party management (Individuals & Organisations)
  - name: Accounts
    description: Account management, party-role associations
  - name: Wallets
    description: Blockchain wallet balances
  - name: Virtual Bank Accounts
    description: Virtual bank account payment references for global payments
  - name: Fiat-to-crypto Payment Sessions
    description: Fiat-to-crypto payment session creation
  - name: Payout Bank Accounts
    description: Allow-listing beneficiary bank accounts as pay-out destinations
  - name: Payout Routes
    description: >-
      Account-scoped routes pairing a beneficiary bank account with a crypto
      deposit asset
  - name: Payouts
    description: Crypto-to-fiat pay-outs over a registered route
  - name: Transfers
    description: Fiat and crypto transfer operations between accounts
  - name: Permits
    description: EIP-712 permit signature management for token approvals
  - name: Supported Assets
    description: >-
      Discover which chains and assets your tenant can settle in, and whether an
      account can use them yet.
  - name: Allowances
    description: Token allowance management for wallets
  - name: Webhooks
    description: Webhook registration and delivery testing
paths:
  /accounts/{accountId}/payout-routes:
    post:
      tags:
        - Payout Routes
      summary: Create a payout route
      description: >
        **Requires scope:** `manage:pay-outs`


        Creates an account-scoped pay-out route connecting an allow-listed

        [payout bank
        account](/api-reference/Finance-API/payout-bank-accounts/register-a-payout-bank-account)

        to a crypto deposit asset. A route fixes the beneficiary, the lane, the
        asset, and the fiat

        currency for every pay-out made over it.


        The provider is resolved internally — intersecting provider capability
        with your tenant's

        enablement — so the request never names one, and provider identity is
        never exposed.


        The **recipient gate** must pass: the bank account's party needs an
        `ACTIVE`

        `PAYOUT_RECIPIENT` role on this account with cleared KYC/KYB. Add the
        role via

        [Add a party to an
        account](/api-reference/Finance-API/accounts/add-a-party-to-an-account).

        A party may hold `PAYOUT_RECIPIENT` alongside `ACCOUNT_HOLDER` on the
        same account, which is

        the self-payout case.


        A route is created `PENDING` and progresses `REGISTERING → ACTIVE` as
        provider registration

        completes, or `REJECTED` if it fails terminally. Only `ACTIVE` routes
        are usable.
      operationId: createPayoutRoute
      parameters:
        - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutRouteRequest'
            example:
              payoutBankAccountId: a1b2c3d4-e5f6-4708-9a1b-2c3d4e5f6071
              depositAsset:
                chain: BASE
                name: USDC
      responses:
        '201':
          description: Route created (PENDING)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinglePayoutRouteResponse'
              example:
                success: true
                result:
                  id: b2c3d4e5-f607-4819-a2b3-c4d5e6f70819
                  status: PENDING
                  depositAsset:
                    chain: BASE
                    name: USDC
                  fiatCurrency: USD
                  depositAddress: null
                  createdAt: '2026-07-14T09:20:00Z'
                  updatedAt: '2026-07-14T09:20:00Z'
        '400':
          description: >-
            Invalid request — a required field is missing
            (`payoutBankAccountId`, `depositAsset.chain`, `depositAsset.name`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Forbidden — the caller lacks the `manage:pay-outs` role.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The account or payout bank account was not found. Also returned for
            cross-company resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            `route-already-exists` — a route already exists for this account,
            bank account and deposit asset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >
            Unprocessable. Possible error codes:

            - `recipient-not-authorized` — the bank account's party has no
            `PAYOUT_RECIPIENT` role on this account, or its KYC/KYB is not
            cleared

            - `recipient-role-inactive` — the `PAYOUT_RECIPIENT` role exists but
            is `INACTIVE`

            - `unsupported-asset` — the deposit asset is not supported for your
            company

            - `unsupported-combination` — no single provider resolves for this
            bank account and deposit asset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    AccountId:
      name: accountId
      in: path
      required: true
      description: Unique account identifier
      schema:
        type: string
        format: uuid
      example: b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f
  schemas:
    CreatePayoutRouteRequest:
      type: object
      description: >
        Creates a pay-out route. The owning account comes from the path, and the
        provider is resolved

        internally — the request never names one.
      required:
        - payoutBankAccountId
        - depositAsset
      properties:
        payoutBankAccountId:
          type: string
          format: uuid
          description: An allow-listed payout bank account belonging to your company
        depositAsset:
          $ref: '#/components/schemas/DepositAsset'
    SinglePayoutRouteResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              $ref: '#/components/schemas/PayoutRoute'
    ErrorResponse:
      type: object
      description: Error response wrapper
      properties:
        success:
          type: boolean
          description: Always false for error responses
          example: false
        errors:
          type: array
          description: List of errors that occurred
          items:
            $ref: '#/components/schemas/ErrorBody'
        result:
          type: object
          nullable: true
          description: Null or omitted when success is false
    DepositAsset:
      type: object
      description: >-
        The crypto asset a customer sends to fund a route — a (chain, name)
        pair.
      required:
        - chain
        - name
      properties:
        chain:
          $ref: '#/components/schemas/BlockchainNetwork'
        name:
          type: string
          maxLength: 50
          description: Crypto asset name
          example: USDC
    BaseResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful
    PayoutRoute:
      type: object
      description: Customer-facing route view. Provider identity is never exposed.
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PayoutRouteStatus'
        depositAsset:
          $ref: '#/components/schemas/DepositAsset'
        fiatCurrency:
          type: string
        depositAddress:
          type: string
          nullable: true
          description: >
            The address a customer sends to for a PUSH pay-out. Included
            **only** for an `ACTIVE` route

            on a `SELF_CUSTODY` account; null or omitted otherwise.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorBody:
      type: object
      description: Individual error details
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid-request
        message:
          type: string
          description: Human-readable error message
          example: The request contains invalid parameters.
    BlockchainNetwork:
      type: string
      description: >
        Supported blockchain network. Availability per chain depends on your
        company's configured

        `supportedChains` — see [Supported chains and
        assets](/guides/finance/supported-chains-and-assets).
      enum:
        - AVALANCHE
        - BASE
        - ETHEREUM
        - POLYGON
        - SOLANA
    PayoutRouteStatus:
      type: string
      description: >
        Lifecycle of a payout route. Only `ACTIVE` routes can be used for
        pay-outs or as PUSH deposit

        addresses.

        - `PENDING` — created; provider registration not yet started

        - `REGISTERING` — provider registration in progress

        - `AWAITING_OWNERSHIP_PROOF` — waiting for the owner of a self-custody
        source wallet to sign
          a wallet-ownership proof. Registration is paused until you submit it — see
          [Submit a pay-out route ownership proof](/api-reference/Finance-API/payout-routes/submit-a-route-ownership-proof).
          This is the only status that needs an action from you.
        - `ACTIVE` — registered; `depositAddress` populated

        - `REJECTED` — registration failed terminally or was rejected
      enum:
        - PENDING
        - REGISTERING
        - AWAITING_OWNERSHIP_PROOF
        - ACTIVE
        - REJECTED
  responses:
    Unauthorized:
      description: Authentication required or failed (401)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: unauthenticated
                message: Please authenticate to perform this action.
    InternalServerError:
      description: Unexpected server error (500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: internal-error
                message: An unexpected error occurred. Please try again later.
  securitySchemes:
    OAuth2:
      type: oauth2
      description: >
        OAuth2 client credentials flow. Token endpoints:

        - Staging:
        https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

        - Production:
        https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
      flows:
        clientCredentials:
          tokenUrl: >-
            https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
          scopes: {}

````