> ## 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 bank accounts

> List a party's allow-listed pay-out destinations, with account numbers masked.

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

Returns a paginated list of the party's allow-listed bank accounts. Account numbers are masked to the last 4 digits.

Only accounts with `status: ACTIVE` can back a payout route.


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts
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:
  /parties/{partyId}/payout-bank-accounts:
    get:
      tags:
        - Payout Bank Accounts
      summary: List payout bank accounts
      description: >
        **Requires scope:** `manage:pay-outs`


        Returns a paginated list of the recipient party's allow-listed bank
        accounts. Account numbers

        are masked to the last 4 digits.
      operationId: listPayoutBankAccounts
      parameters:
        - $ref: '#/components/parameters/PartyId'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Size'
        - $ref: '#/components/parameters/SortOn'
        - $ref: '#/components/parameters/SortOrder'
      responses:
        '200':
          description: List of payout bank accounts (masked)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutBankAccountListResponse'
              example:
                success: true
                result:
                  - id: a1b2c3d4-e5f6-4708-9a1b-2c3d4e5f6071
                    partyId: 7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22
                    rail: US_ACH
                    fiatCurrency: USD
                    label: Jane's checking account
                    accountHolderName: Jane Doe
                    details:
                      accountNumberLast4: '9012'
                      abaRoutingNumber: '021000021'
                      accountType: CHECKING
                    bankName: Example National Bank
                    status: ACTIVE
                    createdAt: '2026-07-14T09:12:44Z'
                    updatedAt: '2026-07-14T10:02:10Z'
                pagination:
                  pageNumber: 1
                  pageSize: 20
                  numberOfElements: 1
                  numberOfPages: 1
                  hasNextPage: false
                  hasPreviousPage: false
        '400':
          description: Invalid pagination or sort parameter.
          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':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PartyId:
      name: partyId
      in: path
      required: true
      description: Unique party identifier
      schema:
        type: string
        format: uuid
      example: 7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22
    Page:
      name: page
      in: query
      description: Page number (1-based indexing)
      required: false
      schema:
        type: integer
        format: int32
        default: 1
        minimum: 1
      example: 1
    Size:
      name: size
      in: query
      description: Number of items per page
      required: false
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
      example: 20
    SortOn:
      name: sortOn
      in: query
      description: Field to sort by
      required: false
      schema:
        type: string
        default: createdAt
      example: createdAt
    SortOrder:
      name: sortOrder
      in: query
      description: Sort direction
      required: false
      schema:
        type: string
        default: ASC
        enum:
          - ASC
          - DESC
      example: DESC
  schemas:
    PayoutBankAccountListResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              type: array
              items:
                $ref: '#/components/schemas/PayoutBankAccount'
            pagination:
              $ref: '#/components/schemas/Pagination'
    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
    PayoutBankAccount:
      type: object
      description: Masked view of an allow-listed payout bank account.
      properties:
        id:
          type: string
          format: uuid
        partyId:
          type: string
          format: uuid
        rail:
          $ref: '#/components/schemas/PayoutRail'
        fiatCurrency:
          type: string
        label:
          type: string
        accountHolderName:
          type: string
        details:
          $ref: '#/components/schemas/MaskedRailDetails'
        bankName:
          type: string
        bankAddress:
          $ref: '#/components/schemas/BankAddress'
        status:
          $ref: '#/components/schemas/PayoutBankAccountStatus'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      description: Pagination metadata (top-level sibling of `result`)
      properties:
        pageNumber:
          type: integer
          format: int32
          description: Current page number (1-based)
        pageSize:
          type: integer
          format: int32
          description: Number of items per page
        numberOfElements:
          type: integer
          format: int64
          description: Total number of items across all pages
        numberOfPages:
          type: integer
          format: int32
          description: Total number of pages
        hasNextPage:
          type: boolean
          description: Whether there is a next page
        hasPreviousPage:
          type: boolean
          description: Whether there is a previous page
    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.
    PayoutRail:
      type: string
      description: |
        The fiat rail a payout bank account settles over.
        - `US_ACH` — US ACH transfer. Requires `fiatCurrency: USD`.
      enum:
        - US_ACH
    MaskedRailDetails:
      type: object
      description: Masked rail credentials, returned on every read path.
      properties:
        accountNumberLast4:
          type: string
          description: >-
            Last 4 digits of the account number. The full number is never
            returned.
          example: '9012'
        abaRoutingNumber:
          type: string
          description: ABA routing number, returned in full (a public bank identifier).
          example: '021000021'
        accountType:
          $ref: '#/components/schemas/AchAccountType'
    BankAddress:
      type: object
      description: >
        Structured postal address of the **beneficiary's bank** — not the
        recipient's own address. All

        components are required on registration, and `country` must be a valid
        ISO 3166-1 alpha-2

        code; anything missing or invalid yields `400 invalid-bank-address`.
      required:
        - street1
        - city
        - region
        - postalCode
        - country
      properties:
        street1:
          type: string
          maxLength: 255
        city:
          type: string
          maxLength: 100
        region:
          type: string
          maxLength: 100
          description: State, province or region
        postalCode:
          type: string
          maxLength: 20
        country:
          type: string
          maxLength: 2
          description: ISO 3166-1 alpha-2 country code
          example: US
    PayoutBankAccountStatus:
      type: string
      description: |
        Lifecycle status of a payout bank account.
        - `PENDING` — registered, not yet activated for pay-outs
        - `ACTIVE` — usable as a pay-out destination
        - `DISABLED` — no longer usable
      enum:
        - PENDING
        - ACTIVE
        - DISABLED
    AchAccountType:
      type: string
      description: >-
        Type of US-ACH bank account, supplied when registering a payout bank
        account.
      enum:
        - CHECKING
        - SAVINGS
  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.
  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: {}

````