Transfer
List Transfers
List all transfers
AuthorizationBearer <token>
In: header
Query Parameters
pagestring
Page number of the list (default: 1)
Default
"1"limitstring
Number of items per page (default: 10)
Default
"10"customer?string
Query by Customer ID.
status?string
Query by Payout status.
Value in
"pendingFunding" | "pendingReview" | "fundsReceived" | "processing" | "succeeded" | "undeliverable" | "returned" | "pendingRefundInformation" | "failed" | "canceled" | "refunded" | "unexpectedError" | "failedPrecondition"type?string
Query by Payout type.
Value in
"offRamp" | "onChain" | "onRamp" | "microdeposit"Response Body
curl -X GET "https://api.spherepay.co/v2/transfer?page=1&limit=10&customer=customer_123abc...&status=succeeded&type=onRamp"{
"data": [],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1,
"hasNext": false,
"hasPrevious": false
}
}{
"status": 400,
"detail": "Invalid request parameters",
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 404,
"detail": "Resource not found",
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 422,
"detail": "Validation failed",
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
]
}