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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
string
default:1
required

Page number of the list (default: 1)

Example:

1

limit
string
default:10
required

Number of items per page (default: 10)

Example:

10

customer
string

Query by Customer ID.

Example:

"customer_123abc..."

status
enum<string>

Query by Payout status. See Transfer Lifecycle for status definitions.

Available options:
pendingFunding,
pendingReview,
fundsReceived,
processing,
succeeded,
undeliverable,
returned,
pendingRefundInformation,
failed,
canceled,
refunded,
unexpectedError,
failedPrecondition,
expired
Example:

"succeeded"

type
enum<string>

Query by Payout type.

Available options:
offRamp,
onChain,
onRamp,
microdeposit,
unmatchedDeposit
Example:

"onRamp"

sort
string
default:-created
required

Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated, status, type, amount. Example: "type,-created".

Example:

"-created"

Response

data
object[]
required

Array of transfer objects.

Example:
pagination
object
required
Last modified on June 18, 2026