---
title: "List Transfers"
method: GET
path: "/v2/transfer"
---

# List Transfers

`GET /v2/transfer`

List all transfers

## Query parameters

- `page` string, required
- `limit` string, required
- `customer` string
- `status` 'pendingFunding' | 'pendingReview' | 'fundsReceived' | 'processing' | 'succeeded' | 'undeliverable' | 'returned' | 'pendingRefundInformation' | 'failed' | 'canceled' | 'refunded' | 'unexpectedError' | 'failedPrecondition' | 'expired'
- `type` 'offRamp' | 'onChain' | 'onRamp' | 'microdeposit' | 'unmatchedDeposit'
- `sort` string, required

## Response `200`

- ListTransfersResponseDto
  - `data` object[], required — Array of transfer objects.
    - `id` string, required — A unique identifier for transfer.
    - `externalId` string — The external reference (not stored as unique).
    - `type` 'on_ramp' | 'off_ramp' | 'unmatched_deposit' | 'microdeposit', required — The transfer type.
    - `status` 'pendingFunding' | 'pendingReview' | 'fundsReceived' | 'processing' | 'succeeded' | 'undeliverable' | 'returned' | 'pendingRefundInformation' | 'failed' | 'canceled' | 'refunded' | 'unexpectedError' | 'failedPrecondition' | 'expired', required — The transfer status. See [Transfer Lifecycle](/concepts/transfers/lifecycle) for status definitions and transitions.
    - `statusHistory` object[], required — Timeline of status transitions for this transfer, ascending by transitionedAt.
      - `status` 'pendingFunding' | 'pendingReview' | 'fundsReceived' | 'processing' | 'succeeded' | 'undeliverable' | 'returned' | 'pendingRefundInformation' | 'failed' | 'canceled' | 'refunded' | 'unexpectedError' | 'failedPrecondition' | 'expired', required
      - `transitionedAt` string, date-time, required — ISO 8601 timestamp of when the transfer entered this status.
    - `customer` string, required — The customer ID.
    - `fees` object — Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete.
      - `integratorFee` object, required — The integrator fee, this is the portion of the fee that the API integrator will receive.
        - `fixedAmount` string, required — The fixed amount of the fee.
        - `bpsRate` string, required — The BPS rate of the fee.
        - `bpsAmount` string, required — The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount.
        - `totalAmount` string, required — The total amount of the fee applied to the source amount.
        - `currency` 'usdc' | 'usdt' | 'eurc' | 'usd' | 'eur' | 'brl', required — The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
      - `platformFee` object, required — The platform fee, this is the portion of the fee that Sphere will receive.
        - `fixedAmount` string, required — The fixed amount of the fee.
        - `bpsRate` string, required — The BPS rate of the fee.
        - `bpsAmount` string, required — The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount.
        - `totalAmount` string, required — The total amount of the fee applied to the source amount.
        - `currency` 'usdc' | 'usdt' | 'eurc' | 'usd' | 'eur' | 'brl', required — The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
    - `source` union, required
      - object — The source of an on ramp transfer.
        - `id` string, required — The source bank account ID.
        - `type` 'bank_account', required — The source account type.
        - `currency` 'usd' | 'eur' | 'brl', required — The source bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `network` 'ach' | 'wire' | 'sepa' | 'pix' | 'swift', required — The source bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `amount` string, required — The source amount being transferred out of the source bank account.
        - `wireMessage` string — The message included with the wire transfer.
        - `achReference` string — The ACH reference string.
        - `sepaReference` string — The SEPA reference string.
      - object — The source of an off ramp transfer. See [Wallets](/concepts/transfers/wallets) for registration.
        - `id` string, required — The source wallet ID.
        - `type` 'wallet', required — The source type.
        - `currency` 'usdc' | 'usdt' | 'eurc', required — The source wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `network` 'sol' | 'fogo' | 'ethereum' | 'arbitrum' | 'polygon' | 'base' | 'avalanche' | 'sui' | 'noble' | 'sei' | 'tron' | 'starknet' | 'aptos' | 'hyperliquid', required — The source wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `amount` string, required — The source amount being transferred out of the source wallet.
    - `destination` union, required
      - object — The destination of an `On-ramp` transfer. See [Wallets](/concepts/transfers/wallets) for registration.
        - `id` string, required — The destination wallet ID.
        - `type` 'wallet', required — The destination wallet type.
        - `currency` 'usdc' | 'usdt' | 'eurc', required — The destination wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `network` 'sol' | 'fogo' | 'ethereum' | 'arbitrum' | 'polygon' | 'base' | 'avalanche' | 'sui' | 'noble' | 'sei' | 'tron' | 'starknet' | 'aptos' | 'hyperliquid', required — The destination wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `amount` string
        - `exchangeRate` string — The exchange rate applied to the destination amount when converting the source amount to the destination currency.
      - object — The destination of an `Off-ramp` transfer.
        - `id` string, required — The destination bank account ID.
        - `type` 'bank_account', required — The destination account type.
        - `currency` 'usd' | 'eur' | 'brl', required — The destination bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `network` 'ach' | 'wire' | 'sepa' | 'pix' | 'swift', required — The destination bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
        - `amount` string — The destination amount being transferred to the bank account.
        - `exchangeRate` string — The exchange rate applied to the destination amount when converting the source amount to the destination currency.
        - `wireMessage` string — The message included with the wire transfer.
        - `achReference` string — The ACH reference string.
        - `sepaReference` string — The SEPA reference string.
    - `depositAccount` union, required
      - object — The deposit bank account for an on ramp transfer.
        - `type` 'bank_account', required — The type of the deposit account.
        - `bankDetails` object, required
          - `bankName` string — The name of the bank that the source funds will be transferred to.
          - `accountHolderName` string — The name of the bank account holder that the source funds will be transferred to.
          - `accountType` 'savings' | 'checking' — The type of bank account: savings or checking.
          - `accountNumber` string — The account number of the bank account, used for wires, ACH transfers and other applicable networks.
          - `routingNumber` string — The routing number of the bank account, used for wires, ACH transfers and other applicable networks.
          - `bic` string — The BIC of the bank account, used for SEPA transfers and other applicable networks.
          - `iban` string — The IBAN of the bank account, used for SEPA transfers and other applicable networks.
          - `pixKey` string — The PIX key of the deposit bank account, used for PIX transfers.
          - `brCode` string — The PIX BR code for on-ramp payments. Encode this as a QR code for the customer to scan and pay.
          - `bankAddress` string — The address of the deposit bank account.
          - `beneficiaryAddress` string — The address of the beneficiary that will receive the funds.
          - `memo` string — The memo of the transfer. This must be provided when initiating wire, ACH and SEPA transfers. This is the memo that will be used to identify the transfer to the deposit account.
      - object — The deposit wallet for an off ramp transfer.
        - `type` 'wallet', required — The type of the deposit account.
        - `walletDetails` object, required
          - `address` string, required — The address of the wallet that the source funds will be transferred to.
          - `currency` 'usdc' | 'usdt' | 'eurc', required — The currency that should be transferred to the wallet. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
          - `network` 'sol' | 'fogo' | 'ethereum' | 'arbitrum' | 'polygon' | 'base' | 'avalanche' | 'sui' | 'noble' | 'sei' | 'tron' | 'starknet' | 'aptos' | 'hyperliquid', required — The network that the source funds will be transferred on. See [Supported Rails & Currencies](/concepts/transfers/supported-rails).
    - `quote` object — The quote used for this transfer, if any. When present, the locked exchange rate from the quote was applied to the destination amount and exchange rate.
      - `id` string, required — The unique identifier for the quote used for this transfer.
      - `expiresAt` string, date-time, required — The datetime the quote expires.
    - `updated` string, date-time, required — The last datetime the transfer was updated.
    - `created` string, date-time, required — The datetime the transfer was created.
    - `paymentReason` string — The reason for the payment. Present on BRL transfers and third-party off-ramp transfers.
    - `paymentDescription` string — A free-text description of the payment purpose. Present on third-party off-ramp transfers.
  - `pagination` object, required
    - `page` number, required — Current page number
    - `limit` number, required — Number of items per page
    - `total` number, required — Total number of items
    - `totalPages` number, required — Total number of pages
    - `hasNext` boolean, required — Whether there is a next page
    - `hasPrevious` boolean, required — Whether there is a previous page

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Unprocessable Entity - Validation Error

---

[API](https://skmtc.net/spherepay/apis/docs-spherepay-co.md) · [All operations](https://skmtc.net/spherepay/apis/docs-spherepay-co/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spherepay/docs-spherepay-co/versions/4f3f5484aed3/schema)