> ## 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: title: '' description: '' version: 1.0.0 contact: {} servers: - url: https://api.spherepay.co description: Production security: - bearer: [] tags: [] paths: /v2/transfer: get: summary: List Transfers description: List all transfers parameters: - name: page required: true in: query description: 'Page number of the list (default: 1)' schema: default: '1' example: 1 type: string - name: limit required: true in: query description: 'Number of items per page (default: 10)' schema: default: '10' example: 10 type: string - name: customer required: false in: query description: Query by Customer ID. schema: example: customer_123abc... type: string - name: status required: false in: query description: >- Query by Payout status. See [Transfer Lifecycle](/concepts/transfers/lifecycle) for status definitions. x-enumNames: - PENDING_FUNDING - PENDING_REVIEW - FUNDS_RECEIVED - PROCESSING - SUCCEEDED - UNDELIVERABLE - RETURNED - PENDING_REFUND_INFO - FAILED - CANCELED - REFUNDED - UNEXPECTED_ERROR - FAILED_PRECONDITION - EXPIRED schema: example: succeeded type: string enum: - pendingFunding - pendingReview - fundsReceived - processing - succeeded - undeliverable - returned - pendingRefundInformation - failed - canceled - refunded - unexpectedError - failedPrecondition - expired - name: type required: false in: query description: Query by Payout type. x-enumNames: - OffRamp - OnChain - OnRamp - Microdeposit - UnmatchedDeposit schema: example: onRamp type: string enum: - offRamp - onChain - onRamp - microdeposit - unmatchedDeposit - name: sort required: true in: query description: >- Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated, status, type, amount. Example: "type,-created". schema: default: '-created' example: '-created' type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListTransfersResponseDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' examples: Bad Request: summary: Bad Request value: status: 400 detail: Invalid request parameters code: address/invalid correlationId: 28c61e885c6e5eaa78c1a2183a9b883c '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' examples: Not Found: summary: Not Found value: status: 404 detail: Resource not found code: resource/not-found correlationId: 28c61e885c6e5eaa78c1a2183a9b883c '422': description: Unprocessable Entity - Validation Error content: application/json: schema: $ref: '#/components/schemas/ProblemDetailsDto' examples: Validation Error: summary: Validation Error value: status: 422 detail: Validation failed code: validation/failed correlationId: 28c61e885c6e5eaa78c1a2183a9b883c errors: - detail: Invalid email format pointer: /email - detail: Name is required pointer: /name components: schemas: ListTransfersResponseDto: type: object properties: data: description: Array of transfer objects. example: [] type: array items: type: object properties: id: description: A unique identifier for transfer. example: payout_a1b2c3d4e5f6a7b8c9d0e1f2 pattern: ^payout_[a-z0-9]{24}$ type: string externalId: description: The external reference (not stored as unique). example: merchant_ref_123 type: string type: description: The transfer type. example: on_ramp type: string enum: - on_ramp - off_ramp - unmatched_deposit - microdeposit status: description: >- The transfer status. See [Transfer Lifecycle](/concepts/transfers/lifecycle) for status definitions and transitions. example: pendingFunding type: string enum: - pendingFunding - pendingReview - fundsReceived - processing - succeeded - undeliverable - returned - pendingRefundInformation - failed - canceled - refunded - unexpectedError - failedPrecondition - expired x-enumNames: - PENDING_FUNDING - PENDING_REVIEW - FUNDS_RECEIVED - PROCESSING - SUCCEEDED - UNDELIVERABLE - RETURNED - PENDING_REFUND_INFO - FAILED - CANCELED - REFUNDED - UNEXPECTED_ERROR - FAILED_PRECONDITION - EXPIRED customer: description: The customer ID. example: customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7 type: string fees: description: >- Fee breakdown for the transfer. For floating-rate BRL transfers, this is omitted until settlement is complete. type: object properties: integratorFee: description: >- The integrator fee, this is the portion of the fee that the API integrator will receive. example: fixedAmount: '1.00' bpsRate: '10' bpsAmount: '0.10' totalAmount: '1.10' currency: usd type: object properties: fixedAmount: description: The fixed amount of the fee. example: '1.00' type: string bpsRate: description: The BPS rate of the fee. example: '10' type: string bpsAmount: description: >- The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount. example: '0.10' type: string totalAmount: description: >- The total amount of the fee applied to the source amount. example: '1.10' type: string currency: description: >- The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usd type: string enum: - usdc - usdt - eurc - usd - eur - brl required: - fixedAmount - bpsRate - bpsAmount - totalAmount - currency platformFee: description: >- The platform fee, this is the portion of the fee that Sphere will receive. example: fixedAmount: '2.00' bpsRate: '10' bpsAmount: '0.10' totalAmount: '2.10' currency: usd type: object properties: fixedAmount: description: The fixed amount of the fee. example: '1.00' type: string bpsRate: description: The BPS rate of the fee. example: '10' type: string bpsAmount: description: >- The dollar amount derived from the BPS rate. Equal to totalAmount minus fixedAmount. example: '0.10' type: string totalAmount: description: >- The total amount of the fee applied to the source amount. example: '1.10' type: string currency: description: >- The currency of the fee. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usd type: string enum: - usdc - usdt - eurc - usd - eur - brl required: - fixedAmount - bpsRate - bpsAmount - totalAmount - currency required: - integratorFee - platformFee source: oneOf: - title: Source Bank Account description: The source of an on ramp transfer. example: id: bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 type: bank_account type: object properties: id: description: The source bank account ID. example: bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 pattern: ^bankAccount_[a-z0-9]+$ type: string type: description: The source account type. example: bank_account type: string enum: - bank_account currency: description: >- The source bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usd type: string enum: - usd - eur - brl network: description: >- The source bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: wire type: string enum: - ach - wire - sepa - pix - swift amount: description: >- The source amount being transferred out of the source bank account. example: '100.00' type: string wireMessage: description: The message included with the wire transfer. example: Payment for invoice 12345 type: string achReference: description: The ACH reference string. example: ABC123456789 type: string sepaReference: description: The SEPA reference string. example: ABC123456789 type: string required: - id - type - currency - network - amount - title: Source Wallet description: >- The source of an off ramp transfer. See [Wallets](/concepts/transfers/wallets) for registration. type: object properties: id: description: The source wallet ID. example: wallet_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1 pattern: ^wallet_[a-z0-9]+$ type: string type: description: The source type. example: wallet type: string enum: - wallet currency: description: >- The source wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usdc type: string enum: - usdc - usdt - eurc network: description: >- The source wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: sol type: string enum: - sol - fogo - ethereum - optimism - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid amount: description: >- The source amount being transferred out of the source wallet. example: '100.00' type: string required: - id - type - currency - network - amount destination: oneOf: - title: Destination Wallet description: >- The destination of an `On-ramp` transfer. See [Wallets](/concepts/transfers/wallets) for registration. type: object properties: id: description: The destination wallet ID. example: wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2 pattern: ^wallet_[a-z0-9]+$ type: string type: description: The destination wallet type. example: wallet type: string enum: - wallet currency: description: >- The destination wallet currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usdc type: string enum: - usdc - usdt - eurc network: description: >- The destination wallet network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: sol type: string enum: - sol - fogo - ethereum - optimism - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid amount: 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 required: - id - type - currency - network - title: Destination Bank Account description: The destination of an `Off-ramp` transfer. type: object properties: id: description: The destination bank account ID. example: bankAccount_f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3 pattern: ^bankAccount_[a-z0-9]+$ type: string type: description: The destination account type. example: bank_account type: string enum: - bank_account currency: description: >- The destination bank account currency. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: usd type: string enum: - usd - eur - brl network: description: >- The destination bank account network. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: wire type: string enum: - ach - wire - sepa - pix - swift amount: description: >- The destination amount being transferred to the bank account. example: '98.90' 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 wireMessage: description: The message included with the wire transfer. example: Payment for invoice 12345 type: string achReference: description: The ACH reference string. example: ABC123456789 type: string sepaReference: description: The SEPA reference string. example: ABC123456789 type: string required: - id - type - currency - network depositAccount: oneOf: - title: Deposit Bank Account description: The deposit bank account for an on ramp transfer. type: object properties: type: description: The type of the deposit account. example: bank_account type: string enum: - bank_account bankDetails: type: object properties: bankName: description: >- The name of the bank that the source funds will be transferred to. example: Bank of America type: string accountHolderName: description: >- The name of the bank account holder that the source funds will be transferred to. example: John Doe type: string accountType: description: 'The type of bank account: savings or checking.' example: savings type: string enum: - savings - checking accountNumber: description: >- The account number of the bank account, used for wires, ACH transfers and other applicable networks. example: '1234567890' type: string routingNumber: description: >- The routing number of the bank account, used for wires, ACH transfers and other applicable networks. example: '1234567890' type: string bic: description: >- The BIC of the bank account, used for SEPA transfers and other applicable networks. example: '1234567890' type: string iban: description: >- The IBAN of the bank account, used for SEPA transfers and other applicable networks. example: '1234567890' type: string pixKey: description: >- The PIX key of the deposit bank account, used for PIX transfers. example: '+5511999999999' 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 bankAddress: description: The address of the deposit bank account. example: 123 Main St, Anytown, USA type: string beneficiaryAddress: description: >- The address of the beneficiary that will receive the funds. example: 123 Main St, Anytown, USA 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 required: - type - bankDetails - title: Deposit Wallet description: The deposit wallet for an off ramp transfer. type: object properties: type: description: The type of the deposit account. example: wallet type: string enum: - wallet walletDetails: type: object 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). example: usdc type: string enum: - usdc - usdt - eurc network: description: >- The network that the source funds will be transferred on. See [Supported Rails & Currencies](/concepts/transfers/supported-rails). example: ethereum type: string enum: - sol - fogo - ethereum - optimism - arbitrum - polygon - base - avalanche - sui - noble - sei - tron - starknet - aptos - hyperliquid required: - address - currency - network required: - type - walletDetails 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. type: object properties: id: description: >- The unique identifier for the quote used for this transfer. example: quote_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 type: string expiresAt: description: The datetime the quote expires. example: '2021-01-01T00:00:00.000Z' type: string format: date-time required: - id - expiresAt updated: description: The last datetime the transfer was updated. example: '2021-01-01T00:00:00.000Z' type: string format: date-time created: description: The datetime the transfer was created. example: '2021-01-01T00:00:00.000Z' type: string format: date-time paymentReason: description: >- The reason for the payment. Present on BRL transfers and third-party off-ramp transfers. example: professional_services 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 required: - id - type - status - customer - source - destination - depositAccount - updated - created pagination: type: object properties: page: description: Current page number example: 1 type: number limit: description: Number of items per page example: 10 type: number minimum: 1 exclusiveMinimum: false maximum: 100 exclusiveMaximum: false total: description: Total number of items example: 1 type: number totalPages: description: Total number of pages example: 1 type: number hasNext: description: Whether there is a next page example: false type: boolean hasPrevious: description: Whether there is a previous page example: false type: boolean required: - page - limit - total - totalPages - hasNext - hasPrevious required: - data - pagination ProblemDetailsDto: type: object properties: title: type: string status: type: integer detail: type: string code: type: string errors: type: array items: type: object properties: detail: type: string pointer: type: string parameter: type: string header: type: string required: - detail correlationId: type: string required: - status - detail securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````