> ## Documentation Index > Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt > Use this file to discover all available pages before exploring further. # List On-Ramp and Off-Ramp Transfers > List all transfers Use this endpoint to retrieve all transfers associated with your SpherePay account. You can narrow results by customer, transfer status, or transfer type. Results are paginated — use the `page` and `limit` parameters to step through large result sets. ## OpenAPI ````yaml openapi/spherepay.yaml GET /v2/transfer openapi: 3.0.0 info: contact: {} description: The Sphere REST API for payments, transfers, and accounts. title: Sphere API version: '2' servers: - description: Production url: https://api.spherepay.co security: - bearer: [] tags: [] paths: /v2/transfer: get: summary: List Transfers description: List all transfers operationId: getV2Transfer parameters: - description: 'Page number of the list (default: 1)' in: query name: page required: true schema: default: '1' example: 1 type: string - description: 'Number of items per page (default: 10)' in: query name: limit required: true schema: default: '10' example: 10 type: string - description: Query by Customer ID. in: query name: customer required: false schema: example: customer_123abc... type: string - description: >- Query by Payout status. See [Transfer Lifecycle](/concepts/transfers/lifecycle) for status definitions. in: query name: status required: false schema: enum: - pendingFunding - pendingReview - fundsReceived - processing - succeeded - undeliverable - returned - pendingRefundInformation - failed - canceled - refunded - unexpectedError - failedPrecondition - expired - unfunded example: succeeded type: string x-enumNames: - PENDING_FUNDING - PENDING_REVIEW - FUNDS_RECEIVED - PROCESSING - SUCCEEDED - UNDELIVERABLE - RETURNED - PENDING_REFUND_INFO - FAILED - CANCELED - REFUNDED - UNEXPECTED_ERROR - FAILED_PRECONDITION - EXPIRED - UNFUNDED - description: Query by Payout type. in: query name: type required: false schema: enum: - offRamp - onChain - onRamp - microdeposit - unmatchedDeposit - fiatToFiat example: onRamp type: string x-enumNames: - OffRamp - OnChain - OnRamp - Microdeposit - UnmatchedDeposit - FiatToFiat - description: >- Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated, status, type, amount. Example: "type,-created". in: query name: sort required: true schema: default: '-created' example: '-created' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListTransfersResponseDto' description: '' '400': content: application/json: examples: Bad Request: summary: Bad Request value: code: address/invalid correlationId: 28c61e885c6e5eaa78c1a2183a9b883c detail: Invalid request parameters status: 400 schema: $ref: '#/components/schemas/ProblemDetailsDto' description: Bad Request '404': content: application/json: examples: Not Found: summary: Not Found value: code: resource/not-found correlationId: 28c61e885c6e5eaa78c1a2183a9b883c detail: Resource not found status: 404 schema: $ref: '#/components/schemas/ProblemDetailsDto' description: Not Found '422': content: application/json: examples: Validation Error: summary: Validation Error value: code: validation/failed correlationId: 28c61e885c6e5eaa78c1a2183a9b883c detail: Validation failed errors: - detail: Invalid email format pointer: /email - detail: Name is required pointer: /name status: 422 schema: $ref: '#/components/schemas/ProblemDetailsDto' description: Unprocessable Entity - Validation Error components: schemas: ListTransfersResponseDto: properties: data: description: Array of transfer objects. example: [] items: properties: created: description: The datetime the transfer was created. example: '2021-01-01T00:00:00.000Z' format: date-time type: string customer: description: The customer ID. example: customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7 type: string depositAccount: oneOf: - description: The deposit bank account for an on ramp transfer. properties: bankDetails: properties: accountHolderName: description: >- The name of the bank account holder that the source funds will be transferred to. example: John Doe type: string accountNumber: description: >- The account number of the bank account, used for wires, ACH transfers and other applicable networks. example: '1234567890' type: string accountType: description: 'The type of bank account: savings or checking.' enum: - savings - checking example: savings type: string bankAddress: description: The address of the deposit bank account. example: 123 Main St, Anytown, USA type: string bankName: description: >- The name of the bank that the source funds will be transferred to. example: Bank of America type: string beneficiaryAddress: description: >- The address of the beneficiary that will receive the funds. example: 123 Main St, Anytown, USA type: string bic: description: >- The BIC of the bank account, used for SEPA transfers and other applicable networks. example: '1234567890' type: string brCode: description: >- The PIX BR code for on-ramp payments. Encode this as a QR code for the customer to scan and pay. example: >- 00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: string clabe: description: >- The CLABE of the deposit bank account, used for SPEI transfers in Mexico. example: '012345678901234567' type: string iban: description: >- The IBAN of the bank account, used for SEPA transfers and other applicable networks. example: '1234567890' type: string memo: description: >- 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. example: BBE6C7EB4A3F type: string pixKey: description: >- The PIX key of the deposit bank account, used for PIX transfers. example: '+5511999999999' type: string routingNumber: description: >- The routing number of the bank account, used for wires, ACH transfers and other applicable networks. example: '1234567890' type: string type: object type: description: The type of the deposit account. enum: - bank_account example: bank_account type: string required: - type - bankDetails title: Deposit Bank Account type: object - description: The deposit wallet for an off ramp transfer. properties: type: description: The type of the deposit account. enum: - wallet example: wallet type: string walletDetails: properties: address: description: >- The address of the wallet that the source funds will be transferred to. example: '0x1234567890abcdef1234567890abcdef12345678' type: string currency: description: >- The currency that should be transferred to the wallet. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usdc - usdt - eurc example: usdc type: string network: description: >- The network that the source funds will be transferred on. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - sol - fogo - ethereum - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid example: ethereum type: string required: - address - currency - network type: object required: - type - walletDetails title: Deposit Wallet type: object destination: oneOf: - description: >- The destination of an `On-ramp` transfer. See [Wallets](/concepts/transfers/wallets) for registration. properties: amount: type: string currency: description: >- The destination wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usdc - usdt - eurc example: usdc type: string exchangeRate: description: >- The exchange rate applied to the destination amount when converting the source amount to the destination currency. example: '5.455' type: string id: description: The destination wallet ID. example: wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2 pattern: ^wallet_[a-z0-9]+$ type: string network: description: >- The destination wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - sol - fogo - ethereum - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid example: sol type: string type: description: The destination wallet type. enum: - wallet example: wallet type: string required: - id - type - currency - network title: Destination Wallet type: object - description: The destination of an `Off-ramp` transfer. properties: achReference: description: The ACH reference string. example: ABC123456789 type: string amount: description: >- The destination amount being transferred to the bank account. example: '98.90' type: string currency: description: >- The destination bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usd - eur - brl - mxn example: usd type: string exchangeRate: description: >- The exchange rate applied to the destination amount when converting the source amount to the destination currency. example: '5.455' type: string id: description: The destination bank account ID. example: bankAccount_f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3 pattern: ^bankAccount_[a-z0-9]+$ type: string network: description: >- The destination bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - ach - wire - sepa - pix - swift - spei example: wire type: string sepaReference: description: The SEPA reference string. example: ABC123456789 type: string type: description: The destination account type. enum: - bank_account example: bank_account type: string wireMessage: description: The message included with the wire transfer. example: Payment for invoice 12345 type: string required: - id - type - currency - network title: Destination Bank Account type: object externalId: description: The external reference (not stored as unique). example: merchant_ref_123 type: string fees: description: >- Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete. properties: integratorFee: description: >- The integrator fee, this is the portion of the fee that the API integrator will receive. example: bpsAmount: '0.10' bpsRate: '10' currency: usd fixedAmount: '1.00' totalAmount: '1.10' properties: bpsAmount: description: >- The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount. example: '0.10' type: string bpsRate: description: The BPS rate of the fee. example: '10' type: string currency: description: >- The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usdc - usdt - eurc - usd - eur - brl - mxn example: usd type: string fixedAmount: description: The fixed amount of the fee. example: '1.00' type: string totalAmount: description: >- The total amount of the fee applied to the source amount. example: '1.10' type: string required: - fixedAmount - bpsRate - bpsAmount - totalAmount - currency type: object platformFee: description: >- The platform fee, this is the portion of the fee that Sphere will receive. example: bpsAmount: '0.10' bpsRate: '10' currency: usd fixedAmount: '2.00' totalAmount: '2.10' properties: bpsAmount: description: >- The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount. example: '0.10' type: string bpsRate: description: The BPS rate of the fee. example: '10' type: string currency: description: >- The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usdc - usdt - eurc - usd - eur - brl - mxn example: usd type: string fixedAmount: description: The fixed amount of the fee. example: '1.00' type: string totalAmount: description: >- The total amount of the fee applied to the source amount. example: '1.10' type: string required: - fixedAmount - bpsRate - bpsAmount - totalAmount - currency type: object required: - integratorFee - platformFee type: object id: description: A unique identifier for transfer. example: payout_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 pattern: ^payout_[a-z0-9]{32}$ type: string paymentDescription: description: >- A free-text description of the payment purpose. Present on third-party off-ramp transfers. example: INV-2026-004 - Q1 software services type: string paymentReason: description: >- The reason for the payment. Present on BRL transfers and third-party off-ramp transfers. example: professional_services type: string quote: description: >- 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. properties: expiresAt: description: The datetime the quote expires. example: '2021-01-01T00:00:00.000Z' format: date-time type: string id: description: >- The unique identifier for the quote used for this transfer. example: quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 type: string required: - id - expiresAt type: object source: oneOf: - description: The source of an on ramp transfer. example: id: bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 type: bank_account properties: achReference: description: The ACH reference string. example: ABC123456789 type: string amount: description: >- The source amount being transferred out of the source bank account. example: '100.00' type: string currency: description: >- The source bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usd - eur - brl - mxn example: usd type: string id: description: The source bank account ID. example: bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 pattern: ^bankAccount_[a-z0-9]+$ type: string network: description: >- The source bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - ach - wire - sepa - pix - swift - spei example: wire type: string sepaReference: description: The SEPA reference string. example: ABC123456789 type: string type: description: The source account type. enum: - bank_account example: bank_account type: string wireMessage: description: The message included with the wire transfer. example: Payment for invoice 12345 type: string required: - id - type - currency - network - amount title: Source Bank Account type: object - description: >- The source of an off ramp transfer. See [Wallets](/concepts/transfers/wallets) for registration. properties: amount: description: >- The source amount being transferred out of the source wallet. example: '100.00' type: string currency: description: >- The source wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - usdc - usdt - eurc example: usdc type: string id: description: The source wallet ID. example: wallet_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1 pattern: ^wallet_[a-z0-9]+$ type: string network: description: >- The source wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). enum: - sol - fogo - ethereum - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid example: sol type: string type: description: The source type. enum: - wallet example: wallet type: string required: - id - type - currency - network - amount title: Source Wallet type: object status: description: >- The transfer status. See [Transfer Lifecycle](/concepts/transfers/lifecycle) for status definitions and transitions. enum: - pendingFunding - pendingReview - fundsReceived - processing - succeeded - undeliverable - returned - pendingRefundInformation - failed - canceled - refunded - unexpectedError - failedPrecondition - expired - unfunded example: pendingFunding type: string x-enumNames: - PENDING_FUNDING - PENDING_REVIEW - FUNDS_RECEIVED - PROCESSING - SUCCEEDED - UNDELIVERABLE - RETURNED - PENDING_REFUND_INFO - FAILED - CANCELED - REFUNDED - UNEXPECTED_ERROR - FAILED_PRECONDITION - EXPIRED - UNFUNDED statusHistory: description: >- Timeline of status transitions for this transfer, ascending by transitionedAt. example: - status: pendingFunding transitionedAt: '2026-06-20T14:03:21.000Z' - status: processing transitionedAt: '2026-06-20T14:05:10.000Z' items: description: A single transfer status transition. properties: status: enum: - pendingFunding - pendingReview - fundsReceived - processing - succeeded - undeliverable - returned - pendingRefundInformation - failed - canceled - refunded - unexpectedError - failedPrecondition - expired - unfunded type: string x-enumNames: - PENDING_FUNDING - PENDING_REVIEW - FUNDS_RECEIVED - PROCESSING - SUCCEEDED - UNDELIVERABLE - RETURNED - PENDING_REFUND_INFO - FAILED - CANCELED - REFUNDED - UNEXPECTED_ERROR - FAILED_PRECONDITION - EXPIRED - UNFUNDED transitionedAt: description: >- ISO 8601 timestamp of when the transfer entered this status. example: '2026-06-20T14:05:10.000Z' format: date-time type: string required: - status - transitionedAt title: Transfer Status History Entry type: object type: array type: description: The transfer type. enum: - on_ramp - off_ramp - fiat_to_fiat - unmatched_deposit - microdeposit example: on_ramp type: string updated: description: The last datetime the transfer was updated. example: '2021-01-01T00:00:00.000Z' format: date-time type: string required: - id - type - status - statusHistory - customer - source - destination - depositAccount - updated - created type: object type: array pagination: properties: hasNext: description: Whether there is a next page example: false type: boolean hasPrevious: description: Whether there is a previous page example: false type: boolean limit: description: Number of items per page example: 10 exclusiveMaximum: false exclusiveMinimum: false maximum: 100 minimum: 1 type: number page: description: Current page number example: 1 type: number total: description: Total number of items example: 1 type: number totalPages: description: Total number of pages example: 1 type: number required: - page - limit - total - totalPages - hasNext - hasPrevious type: object required: - data - pagination type: object ProblemDetailsDto: properties: code: type: string correlationId: type: string detail: type: string errors: items: properties: detail: type: string header: type: string parameter: type: string pointer: type: string required: - detail type: object type: array status: type: integer title: type: string required: - status - detail type: object securitySchemes: bearer: bearerFormat: JWT scheme: bearer type: http ````