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

# List payout routes

> List an account's pay-out routes and read PUSH deposit addresses.

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

Lists the account's pay-out routes. Poll this to see a route reach `ACTIVE` before requesting a pay-out over it.

<Note>`depositAddress` is included **only** for an `ACTIVE` route on a `SELF_CUSTODY` account. It is the address a customer sends to in order to trigger a [PUSH pay-out](/guides/finance/payouts#push-pay-outs).</Note>

Provider identity is never exposed.


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml GET /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.


    ## Selecting a tenant


    A token that grants more than one tenant must say which one each request is
    for, in the

    `x-tenant-id` header. With a single-tenant token, omit it. Any value you
    send must exactly match a

    tenant the token grants; a missing, malformed or foreign value is answered
    with a generic

    `403 forbidden` that reveals nothing about which tenants exist. Send the
    header at most once.


    ## Request correlation


    Every response — including `401` and `403` — carries an `X-Correlation-Id`
    header identifying the

    operation in our logs. Quote it in a support request. You may supply your
    own, as

    `X-Correlation-Id` or (as a fallback) `X-Request-Id`, matching
    `^[A-Za-z0-9_.:-]{1,64}$`. A value

    outside that shape is replaced with a generated one rather than rejected.
  version: 1.10.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: >-
      Hosted fiat-to-crypto pay-in sessions. **Coming soon** — not yet enabled;
      use a virtual bank account to receive fiat today.
  - 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, delivery testing and delivery history
  - name: Pay-Ins
    description: >-
      The pay-in ledger — every fiat credit that settled (or failed to settle)
      into an account wallet
  - name: Billing
    description: The invoices Venly has issued to your company
  - name: API Credentials
    description: Self-service management of your company's OAuth client credentials
  - name: Company
    description: Your own company profile
paths:
  /accounts/{accountId}/payout-routes:
    parameters:
      - $ref: '#/components/parameters/TenantId'
    get:
      tags:
        - Payout Routes
      summary: List payout routes
      description: >
        **Requires scope:** `manage:pay-outs`


        Lists the account's pay-out routes. Provider identity is never exposed.


        `depositAddress` is included **only** for an `ACTIVE` route on a
        `SELF_CUSTODY` account — it is

        the address the customer sends to for a PUSH pay-out. It is null or
        omitted otherwise.
      operationId: listPayoutRoutes
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: payoutBankAccountId
          in: query
          required: false
          description: Restrict the list to routes for a single payout bank account
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: List of payout routes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutRouteListResponse'
              example:
                success: true
                result:
                  - id: b2c3d4e5-f607-4819-a2b3-c4d5e6f70819
                    status: ACTIVE
                    depositAsset:
                      chain: BASE
                      name: USDC
                    fiatCurrency: USD
                    depositAddress: '0x9A7f4B2c1D3e5F6a8B0c2D4e6F8a0B2c4D6e8F0a'
                    createdAt: '2026-07-14T09:20:00Z'
                    updatedAt: '2026-07-14T09:24:31Z'
        '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':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    TenantId:
      name: x-tenant-id
      in: header
      required: false
      description: >
        Which tenant the request is scoped to, among those your token grants.
        Omit it when the token

        grants exactly one tenant; it is **required** when the token grants more
        than one. A supplied

        value must exactly match a tenant the token grants.


        Absent when required, blank, malformed, or naming a tenant the token
        does not grant — each gets

        the same generic `403 forbidden`, which reveals neither whether a tenant
        exists nor which ones

        you may use. Send the header once: a repeated header is rejected the
        same way.
      schema:
        type: string
        format: uuid
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    AccountId:
      name: accountId
      in: path
      required: true
      description: Unique account identifier
      schema:
        type: string
        format: uuid
      example: b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f
  schemas:
    PayoutRouteListResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              type: array
              items:
                $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
    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.
    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


        `ACTIVE`, `AWAITING_OWNERSHIP_PROOF` and `REJECTED` each raise a webhook

        (`PAYOUT_ROUTE_ACTIVATED`, `PAYOUT_ROUTE_AWAITING_OWNERSHIP_PROOF`,
        `PAYOUT_ROUTE_REJECTED`), so

        you don't need to poll. Still reconcile routes left in
        `AWAITING_OWNERSHIP_PROOF` now and then:

        delivery is best-effort, and the route only moves once the proof is
        submitted. `PENDING` and

        `REGISTERING` raise no event.
      enum:
        - PENDING
        - REGISTERING
        - AWAITING_OWNERSHIP_PROOF
        - ACTIVE
        - REJECTED
    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
    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
  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.
    NotFound:
      description: Resource not found (404)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: account-not-found
                message: The requested resource was not found.
    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: {}

````

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