Skip to main content
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.

​
Endpoint

GET https://api.spherepay.co/v2/transfer

​
Authentication

All requests require a Bearer token in the Authorization header. 
Authorization: Bearer <token>

​
Query parameters

​
page
string
default:"1"
Page number to retrieve. Defaults to 1.
​
limit
string
default:"10"
Number of transfers to return per page. Defaults to 10.
​
customer
string
Filter by customer ID (e.g. customer_f31121c389624d3697cbf3ea8830b7a4).
​
status
string
Filter by transfer status. Accepted values:pendingFunding, pendingReview, fundsReceived, processing, succeeded, undeliverable, returned, pendingRefundInformation, failed, canceled, refunded, unexpectedError, failedPrecondition, expiredSee Transfer Lifecycle for status definitions.
​
type
string
Filter by transfer type. Accepted values: offRamp, onChain, onRamp, microdeposit, unmatchedDeposit.
  -H "Authorization: Bearer $SPHEREPAY_API_KEY"

​
Response fields

​
data
object[]
Array of transfer objects for the current page. Each object has the same structure as the GET /v2/transfer/ response.
​
pagination
object
Pagination metadata.
  "data": [
    {
      "id": "payout_a1b2c3d4e5f6a7b8c9d0e1f2",
      "type": "on_ramp",
      "status": "succeeded",
      "customer": "customer_f31121c389624d3697cbf3ea8830b7a4",
      "externalId": "merchant_ref_123",
      "source": {
        "id": "bankAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
        "type": "bank_account"
      },
      "destination": {
        "id": "wallet_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
        "type": "wallet",
        "currency": "usdc",
        "network": "sol",
        "amount": "498.50",
        "exchangeRate": "1.00"
      },
      "created": "2026-04-01T10:00:00.000Z",
      "updated": "2026-04-01T10:12:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}

​
Error codes

StatusCodeDescription
400address/invalidOne or more query parameters are invalid.
404resource/not-foundThe requested resource was not found.
422validation/failedQuery parameter validation failed.
Last modified on May 12, 2026