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

# Get a payout

> Read a single pay-out with its masked beneficiary and settlement outcome.

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

Reads a single pay-out in the full shape: the nested `payoutRoute` includes the masked beneficiary bank account, plus `depositAddress` for an `ACTIVE` route on a `SELF_CUSTODY` account.

Use this to confirm the real outcome of a pay-out:

* `settledFiatAmount` — the fiat the provider actually paid out. Null until `COMPLETED`, and typically lower than the crypto sent, net of fees.
* `sendTxHash` — the on-chain send. The managed broadcast for PULL, the observed customer transaction for PUSH.
* `failureReason` — populated for `REJECTED`, `FAILED` and `RETURNED`.

Internal and sensitive fields — the idempotency key, permit material, wallet ids, managed transaction ids and raw provider data — are never returned.


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts/{payoutId}
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}/payouts/{payoutId}:
    get:
      tags:
        - Payouts
      summary: Get a payout
      description: >
        **Requires scope:** `manage:pay-outs`


        Reads a single pay-out in the full shape: the nested `payoutRoute`
        includes the masked

        beneficiary bank account, plus `depositAddress` for an `ACTIVE` route on
        a `SELF_CUSTODY`

        account.


        `settledFiatAmount` is the fiat the provider actually paid out and is
        null until `COMPLETED`.

        `failureReason` is populated for `REJECTED`, `FAILED` and `RETURNED`.


        Internal and sensitive fields — the idempotency key, permit material,
        wallet ids, managed

        transaction ids and raw provider data — are never returned.
      operationId: getPayout
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - $ref: '#/components/parameters/PayoutId'
      responses:
        '200':
          description: The payout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinglePayoutResponse'
        '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 was not found. Also returned for cross-company
            or cross-account resources.
          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
    PayoutId:
      name: payoutId
      in: path
      required: true
      description: Unique payout identifier
      schema:
        type: string
        format: uuid
      example: c3d4e5f6-0718-492a-b3c4-d5e6f708192a
  schemas:
    SinglePayoutResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              $ref: '#/components/schemas/Payout'
    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
    Payout:
      type: object
      description: >
        Full pay-out shape, returned on creation and by the detail read. Never
        carries the idempotency

        key, permit material, internal wallet ids, managed transaction ids or
        raw provider data.
      properties:
        id:
          type: string
          format: uuid
        accountId:
          type: string
          format: uuid
        payoutRoute:
          $ref: '#/components/schemas/PayoutRouteInfo'
        rail:
          allOf:
            - $ref: '#/components/schemas/PayoutRail'
          nullable: true
          description: >-
            The fiat rail this pay-out settles over. Null until the route is
            resolved.
        cryptoAmount:
          type: number
          description: Crypto amount sent (PULL) or observed (PUSH)
          example: 100
        settledFiatAmount:
          type: number
          nullable: true
          description: >-
            Fiat amount actually paid out, as reported by the provider. Null
            until `COMPLETED`.
          example: 99.5
        fundingMode:
          $ref: '#/components/schemas/FundingMode'
        status:
          $ref: '#/components/schemas/PayoutStatus'
        sendTxHash:
          type: string
          nullable: true
          description: >
            On-chain send transaction hash — the managed broadcast for PULL, the
            observed customer

            transaction for PUSH. Null until known.
        requestedAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
          nullable: true
        failureReason:
          type: string
          nullable: true
          description: Populated for `REJECTED`, `FAILED` and `RETURNED`.
    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.
    PayoutRouteInfo:
      type: object
      description: >-
        The route lane nested in the full pay-out shape, including the masked
        beneficiary.
      properties:
        id:
          type: string
          format: uuid
        depositAsset:
          $ref: '#/components/schemas/DepositAsset'
        fiatCurrency:
          type: string
          example: USD
        depositAddress:
          type: string
          nullable: true
          description: Included only for an `ACTIVE` route on a `SELF_CUSTODY` account.
        beneficiary:
          $ref: '#/components/schemas/PayoutBeneficiary'
    PayoutRail:
      type: string
      description: |
        The fiat rail a payout bank account settles over.
        - `US_ACH` — US ACH transfer. Requires `fiatCurrency: USD`.
      enum:
        - US_ACH
    FundingMode:
      type: string
      description: >
        How a pay-out is funded on-chain.

        - `PULL` — Venly sends from the account wallet using the up-front
        permit. Created via the API

        - `PUSH` — the customer already sent to the route's deposit address
        themselves. Created from the
          observed deposit; self-custody only
      enum:
        - PULL
        - PUSH
    PayoutStatus:
      type: string
      description: >
        Pay-out lifecycle. The PULL happy path is

        `REQUESTED → SENDING → PROVIDER_PROCESSING → COMPLETED`; PUSH pay-outs
        start at

        `PROVIDER_PROCESSING`. Note that a fiat leg can still bounce after
        completion

        (`COMPLETED → RETURNED`).

        - `REQUESTED` — created via the API; awaiting dispatch of the managed
        send leg. PULL only

        - `SENDING` — the managed on-chain send is in flight. PULL only

        - `PROVIDER_PROCESSING` — funds reached the provider deposit address;
        awaiting the fiat pay-out

        - `COMPLETED` — the provider reported the fiat pay-out as completed;
        `settledFiatAmount` is set

        - `REJECTED` — request validation failed before dispatch. PULL only.
        Terminal

        - `FAILED` — the managed send leg failed terminally. PULL only. Terminal

        - `RETURNED` — the provider reported the fiat leg as bounced or
        returned. Terminal
      enum:
        - REQUESTED
        - SENDING
        - PROVIDER_PROCESSING
        - COMPLETED
        - REJECTED
        - FAILED
        - RETURNED
    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
    PayoutBeneficiary:
      type: object
      description: >
        Masked beneficiary bank account nested under a pay-out's route. The raw
        account number is

        never returned.
      properties:
        id:
          type: string
          format: uuid
        partyId:
          type: string
          format: uuid
          description: The owning payee party
        rail:
          $ref: '#/components/schemas/PayoutRail'
        label:
          type: string
        accountHolderName:
          type: string
        bankName:
          type: string
        details:
          $ref: '#/components/schemas/MaskedRailDetails'
    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
    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'
    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.
    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: {}

````