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

# Get a direct-route transfer

> Returns the authoritative lifecycle and linked references for one direct-route transfer.

## What this endpoint does

Returns the authoritative lifecycle and linked references for one direct-route transfer.

## When to use it

Use it after a webhook, when investigating a transfer, or when you need its current settlement state.

## Before you call

Authenticate with transfer read access and pass a transfer ID owned by the same tenant account.

## Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

## States and completion

Use the returned lifecycle and reason fields. A held, failed, or returned state is not settlement.

## Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.

Read [Activity and history](/console/activity) for the complete workflow.


## OpenAPI

````yaml /api-reference/openapi.json get /v1/transfers/{id}
openapi: 3.0.0
info:
  title: Wayex API
  description: >-
    Wayex APIs for direct customer payment routes and isolated, prefunded
    Treasury accounts. Each API key is bound to one tenant account and its own
    wallet, settings, webhooks, and reporting.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.sandbox.wayex.com
    description: Sandbox integration environment
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Treasury
    description: >-
      Prefunded AUD and stablecoin wallets for one isolated tenant account.
      Fund, pay, convert, withdraw, track, and reconcile without selecting
      another account.
  - name: Customers
    description: >-
      Onboard end customers, run verification, and manage each customer's
      entitlements.
  - name: Payment routes
    description: >-
      Standing deposit instructions per customer. When a customer funds a route,
      Wayex auto-converts at the live rate and pays out/sends — no quote, no
      lock.
  - name: Transfers
    description: >-
      Read the conversion records produced when customers fund payment routes —
      the live activity feed and per-conversion lifecycle timeline.
  - name: Rates
    description: >-
      The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex
      quotes. Indicative only; the binding price is struck when a route's funds
      land.
  - name: Revenue
    description: Your developer-fee revenue over time.
  - name: Invoices
    description: >-
      Your monthly invoices — Wayex platform fees due, net of your accrued
      developer-fee credit.
  - name: Webhooks
    description: Subscribe to HMAC-signed event webhooks and inspect deliveries.
  - name: API keys
    description: Create, list, and rotate API keys for programmatic access.
  - name: Fees
    description: >-
      Configure your developer fee — the markup withheld from each conversion
      and credited against your monthly invoice.
  - name: Invitations
    description: Accept a team invitation and activate your account.
paths:
  /v1/transfers/{id}:
    get:
      tags:
        - Transfers
      summary: Get a direct-route transfer
      description: >-
        Returns the authoritative lifecycle and linked references for one
        direct-route transfer. Use it after a webhook, when investigating a
        transfer, or when you need its current settlement state.
      operationId: TransferController2_get_v1
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The transfer with its lifecycle timeline.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      id:
                        description: Unique identifier for this transfer.
                        type: string
                        minLength: 1
                      counterpartyId:
                        description: >-
                          The client account (counterparty) this transfer
                          belongs to. For API callers this is always your own
                          account id.
                        type: string
                        minLength: 1
                      customerId:
                        description: The customer this transfer is for.
                        type: string
                        minLength: 1
                      routeId:
                        description: The payment route whose funding spawned this transfer.
                        type: string
                        minLength: 1
                      quoteId:
                        description: >-
                          Reference to the live price struck at funding; absent
                          until the conversion executes.
                        type: string
                        minLength: 1
                      status:
                        description: >-
                          Current lifecycle status. State advances
                          asynchronously, so treat this as the source of truth.
                        type: string
                        enum:
                          - created
                          - validated
                          - screening
                          - fx_executed
                          - completed
                          - awaiting_deposit
                          - deposit_detected
                          - deposit_confirming
                          - deposit_cleared
                          - sweeping
                          - onforwarding
                          - payout_instructed
                          - payout_held
                          - payout_settled
                          - awaiting_payin
                          - payin_cleared
                          - disbursing
                          - sending
                          - send_confirming
                          - pooled
                          - on_hold
                          - frozen
                          - failed
                          - cancelled
                          - returned
                          - expired
                          - reversing
                          - reversed
                      sourceDepositInstructions:
                        oneOf:
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - crypto
                              address:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - USDC
                                  - USDT
                              network:
                                type: string
                                enum:
                                  - ethereum
                                  - base
                                  - arbitrum
                                  - optimism
                                  - polygon
                                  - bsc
                                  - avalanche
                                  - solana
                                  - tron
                              amount:
                                type: string
                                pattern: ^\d+(\.\d+)?$
                            required:
                              - kind
                              - address
                              - currency
                              - network
                              - amount
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - aud
                              bsb:
                                type: string
                                minLength: 1
                              accountNumber:
                                type: string
                                minLength: 1
                              payId:
                                type: string
                              reference:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - AUD
                              amount:
                                type: string
                                pattern: ^\d+(\.\d+)?$
                            required:
                              - kind
                              - bsb
                              - accountNumber
                              - reference
                              - currency
                              - amount
                      references:
                        type: object
                        properties:
                          payoutHoldReason:
                            type: string
                          quoteId:
                            type: string
                            minLength: 1
                          providerQuoteId:
                            type: string
                          liquidationAddress:
                            type: string
                          vaultId:
                            type: string
                          disbursementVaultId:
                            type: string
                          depositReference:
                            type: string
                          payinReference:
                            type: string
                          tradeId:
                            type: string
                          sweepTxId:
                            type: string
                          failedSweepTxIds:
                            type: array
                            items:
                              type: string
                          onforwardTxId:
                            type: string
                          failedOnforwardTxIds:
                            type: array
                            items:
                              type: string
                          onforwardTxHash:
                            type: string
                          onforwardDepositId:
                            type: string
                          fiatWithdrawalId:
                            type: string
                          stablecoinWithdrawalId:
                            type: string
                          fxFundingPayoutId:
                            type: string
                          sendTxId:
                            type: string
                          failedSendTxIds:
                            type: array
                            items:
                              type: string
                          payoutId:
                            type: string
                          ledgerEntryRefs:
                            type: array
                            items:
                              type: string
                      timeline:
                        description: >-
                          Ordered history of the states this transfer passed
                          through, with timestamps.
                        type: array
                        items:
                          type: object
                          properties:
                            status:
                              type: string
                              enum:
                                - created
                                - validated
                                - screening
                                - fx_executed
                                - completed
                                - awaiting_deposit
                                - deposit_detected
                                - deposit_confirming
                                - deposit_cleared
                                - sweeping
                                - onforwarding
                                - payout_instructed
                                - payout_held
                                - payout_settled
                                - awaiting_payin
                                - payin_cleared
                                - disbursing
                                - sending
                                - send_confirming
                                - pooled
                                - on_hold
                                - frozen
                                - failed
                                - cancelled
                                - returned
                                - expired
                                - reversing
                                - reversed
                            at:
                              type: string
                              format: date-time
                            providerRef:
                              type: string
                            description:
                              type: string
                          required:
                            - status
                            - at
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                      createdAt:
                        description: When the transfer was created (ISO 8601).
                        type: string
                        format: date-time
                      updatedAt:
                        description: When the transfer was last updated (ISO 8601).
                        type: string
                        format: date-time
                      type:
                        type: string
                        enum:
                          - offramp
                      source:
                        type: object
                        properties:
                          currency:
                            type: string
                            enum:
                              - USDC
                              - USDT
                          network:
                            type: string
                            enum:
                              - ethereum
                              - base
                              - arbitrum
                              - optimism
                              - polygon
                              - bsc
                              - avalanche
                              - solana
                              - tron
                          amount:
                            type: string
                            pattern: ^\d+(\.\d+)?$
                        required:
                          - currency
                          - network
                          - amount
                      destination:
                        oneOf:
                          - type: object
                            properties:
                              account_holder_name:
                                type: string
                                minLength: 1
                              bsb_code:
                                type: string
                                minLength: 1
                              account_number:
                                type: string
                                minLength: 1
                              bank_country:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - AUD
                            required:
                              - account_holder_name
                              - bsb_code
                              - account_number
                              - bank_country
                              - currency
                          - type: object
                            properties:
                              payid:
                                type: string
                                minLength: 1
                              payid_type:
                                type: string
                                enum:
                                  - email
                                  - phone
                                  - abn
                              account_holder_name:
                                type: string
                                minLength: 1
                              bank_country:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - AUD
                            required:
                              - payid
                              - payid_type
                              - account_holder_name
                              - bank_country
                              - currency
                      destinationAmount:
                        description: >-
                          Net AUD the customer receives as a decimal string; set
                          once the conversion executes ("0" before).
                        type: string
                        pattern: ^\d+(\.\d+)?$
                      destinationCurrency:
                        type: string
                        enum:
                          - AUD
                    required:
                      - id
                      - counterpartyId
                      - customerId
                      - status
                      - sourceDepositInstructions
                      - references
                      - timeline
                      - createdAt
                      - updatedAt
                      - type
                      - source
                      - destination
                      - destinationAmount
                      - destinationCurrency
                  - type: object
                    properties:
                      id:
                        description: Unique identifier for this transfer.
                        type: string
                        minLength: 1
                      counterpartyId:
                        description: >-
                          The client account (counterparty) this transfer
                          belongs to. For API callers this is always your own
                          account id.
                        type: string
                        minLength: 1
                      customerId:
                        description: The customer this transfer is for.
                        type: string
                        minLength: 1
                      routeId:
                        description: The payment route whose funding spawned this transfer.
                        type: string
                        minLength: 1
                      quoteId:
                        description: >-
                          Reference to the live price struck at funding; absent
                          until the conversion executes.
                        type: string
                        minLength: 1
                      status:
                        description: >-
                          Current lifecycle status. State advances
                          asynchronously, so treat this as the source of truth.
                        type: string
                        enum:
                          - created
                          - validated
                          - screening
                          - fx_executed
                          - completed
                          - awaiting_deposit
                          - deposit_detected
                          - deposit_confirming
                          - deposit_cleared
                          - sweeping
                          - onforwarding
                          - payout_instructed
                          - payout_held
                          - payout_settled
                          - awaiting_payin
                          - payin_cleared
                          - disbursing
                          - sending
                          - send_confirming
                          - pooled
                          - on_hold
                          - frozen
                          - failed
                          - cancelled
                          - returned
                          - expired
                          - reversing
                          - reversed
                      sourceDepositInstructions:
                        oneOf:
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - crypto
                              address:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - USDC
                                  - USDT
                              network:
                                type: string
                                enum:
                                  - ethereum
                                  - base
                                  - arbitrum
                                  - optimism
                                  - polygon
                                  - bsc
                                  - avalanche
                                  - solana
                                  - tron
                              amount:
                                type: string
                                pattern: ^\d+(\.\d+)?$
                            required:
                              - kind
                              - address
                              - currency
                              - network
                              - amount
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - aud
                              bsb:
                                type: string
                                minLength: 1
                              accountNumber:
                                type: string
                                minLength: 1
                              payId:
                                type: string
                              reference:
                                type: string
                                minLength: 1
                              currency:
                                type: string
                                enum:
                                  - AUD
                              amount:
                                type: string
                                pattern: ^\d+(\.\d+)?$
                            required:
                              - kind
                              - bsb
                              - accountNumber
                              - reference
                              - currency
                              - amount
                      references:
                        type: object
                        properties:
                          payoutHoldReason:
                            type: string
                          quoteId:
                            type: string
                            minLength: 1
                          providerQuoteId:
                            type: string
                          liquidationAddress:
                            type: string
                          vaultId:
                            type: string
                          disbursementVaultId:
                            type: string
                          depositReference:
                            type: string
                          payinReference:
                            type: string
                          tradeId:
                            type: string
                          sweepTxId:
                            type: string
                          failedSweepTxIds:
                            type: array
                            items:
                              type: string
                          onforwardTxId:
                            type: string
                          failedOnforwardTxIds:
                            type: array
                            items:
                              type: string
                          onforwardTxHash:
                            type: string
                          onforwardDepositId:
                            type: string
                          fiatWithdrawalId:
                            type: string
                          stablecoinWithdrawalId:
                            type: string
                          fxFundingPayoutId:
                            type: string
                          sendTxId:
                            type: string
                          failedSendTxIds:
                            type: array
                            items:
                              type: string
                          payoutId:
                            type: string
                          ledgerEntryRefs:
                            type: array
                            items:
                              type: string
                      timeline:
                        description: >-
                          Ordered history of the states this transfer passed
                          through, with timestamps.
                        type: array
                        items:
                          type: object
                          properties:
                            status:
                              type: string
                              enum:
                                - created
                                - validated
                                - screening
                                - fx_executed
                                - completed
                                - awaiting_deposit
                                - deposit_detected
                                - deposit_confirming
                                - deposit_cleared
                                - sweeping
                                - onforwarding
                                - payout_instructed
                                - payout_held
                                - payout_settled
                                - awaiting_payin
                                - payin_cleared
                                - disbursing
                                - sending
                                - send_confirming
                                - pooled
                                - on_hold
                                - frozen
                                - failed
                                - cancelled
                                - returned
                                - expired
                                - reversing
                                - reversed
                            at:
                              type: string
                              format: date-time
                            providerRef:
                              type: string
                            description:
                              type: string
                          required:
                            - status
                            - at
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                      createdAt:
                        description: When the transfer was created (ISO 8601).
                        type: string
                        format: date-time
                      updatedAt:
                        description: When the transfer was last updated (ISO 8601).
                        type: string
                        format: date-time
                      type:
                        type: string
                        enum:
                          - onramp
                      source:
                        type: object
                        properties:
                          currency:
                            type: string
                            enum:
                              - AUD
                          amount:
                            type: string
                            pattern: ^\d+(\.\d+)?$
                        required:
                          - currency
                          - amount
                      destination:
                        type: object
                        properties:
                          address:
                            type: string
                            minLength: 1
                          currency:
                            type: string
                            enum:
                              - USDC
                              - USDT
                          network:
                            type: string
                            enum:
                              - ethereum
                              - base
                              - arbitrum
                              - optimism
                              - polygon
                              - bsc
                              - avalanche
                              - solana
                              - tron
                        required:
                          - address
                          - currency
                          - network
                      destinationAmount:
                        description: >-
                          Net stablecoin the customer receives as a decimal
                          string; set once the conversion executes ("0" before).
                        type: string
                        pattern: ^\d+(\.\d+)?$
                      destinationCurrency:
                        type: string
                        enum:
                          - USDC
                          - USDT
                    required:
                      - id
                      - counterpartyId
                      - customerId
                      - status
                      - sourceDepositInstructions
                      - references
                      - timeline
                      - createdAt
                      - updatedAt
                      - type
                      - source
                      - destination
                      - destinationAmount
                      - destinationCurrency
        '404':
          description: No such transfer for this account.
      security:
        - Bearer: []
        - ApiKey: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Wayex API key
      description: 'Send the same Wayex API key as `Authorization: Bearer <key>`.'
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: A Wayex API key. Use a secret key for write operations.

````